From 002df0c33689f776bec46a533b8631b2c349aa02 Mon Sep 17 00:00:00 2001 From: David Gamero Date: Tue, 6 Jan 2026 16:41:15 -0500 Subject: [PATCH 1/3] update gen hash --- settings | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/settings b/settings index 1e351cdcf8..88b18c470b 100644 --- a/settings +++ b/settings @@ -30,4 +30,4 @@ export CLIENT_VERSION="0.8-SNAPSHOT" # Name of the release package export PACKAGE_NAME="@kubernetes/node-client" -export OPENAPI_GENERATOR_COMMIT=d06ed32df0a30fe12a1c7ba98722c12e867b6060 +export OPENAPI_GENERATOR_COMMIT=6e0fe098f1d9631c696135c7a3c46e4b0dc9ab3f From d3c8259e854b49d8fa0e1911399df94637c7d7a0 Mon Sep 17 00:00:00 2001 From: David Gamero Date: Tue, 6 Jan 2026 16:42:08 -0500 Subject: [PATCH 2/3] regen with headers fix --- src/gen/.openapi-generator/COMMIT | 4 +- src/gen/.openapi-generator/FILES | 130 +- src/gen/.openapi-generator/VERSION | 2 +- src/gen/docs/AdmissionregistrationApi.md | 57 + src/gen/docs/AdmissionregistrationV1Api.md | 3762 ++ .../docs/AdmissionregistrationV1alpha1Api.md | 1745 + .../docs/AdmissionregistrationV1beta1Api.md | 1745 + src/gen/docs/ApiextensionsApi.md | 57 + src/gen/docs/ApiextensionsV1Api.md | 1479 + src/gen/docs/ApiregistrationApi.md | 57 + src/gen/docs/ApiregistrationV1Api.md | 1026 + src/gen/docs/ApisApi.md | 57 + src/gen/docs/AppsApi.md | 57 + src/gen/docs/AppsV1Api.md | 28117 +++++++++++ src/gen/docs/AuthenticationApi.md | 57 + src/gen/docs/AuthenticationV1Api.md | 324 + src/gen/docs/AuthorizationApi.md | 57 + src/gen/docs/AuthorizationV1Api.md | 704 + src/gen/docs/AutoscalingApi.md | 57 + src/gen/docs/AutoscalingV1Api.md | 1120 + src/gen/docs/AutoscalingV2Api.md | 1828 + src/gen/docs/BatchApi.md | 57 + src/gen/docs/BatchV1Api.md | 13484 ++++++ src/gen/docs/CertificatesApi.md | 57 + src/gen/docs/CertificatesV1Api.md | 1326 + src/gen/docs/CertificatesV1alpha1Api.md | 714 + src/gen/docs/CertificatesV1beta1Api.md | 1819 + src/gen/docs/CoordinationApi.md | 57 + src/gen/docs/CoordinationV1Api.md | 830 + src/gen/docs/CoordinationV1alpha2Api.md | 828 + src/gen/docs/CoordinationV1beta1Api.md | 828 + src/gen/docs/CoreApi.md | 57 + src/gen/docs/CoreV1Api.md | 39216 ++++++++++++++++ src/gen/docs/CustomObjectsApi.md | 2230 + src/gen/docs/DiscoveryApi.md | 57 + src/gen/docs/DiscoveryV1Api.md | 908 + src/gen/docs/EventsApi.md | 57 + src/gen/docs/EventsV1Api.md | 884 + src/gen/docs/FlowcontrolApiserverApi.md | 57 + src/gen/docs/FlowcontrolApiserverV1Api.md | 2142 + src/gen/docs/InternalApiserverApi.md | 57 + src/gen/docs/InternalApiserverV1alpha1Api.md | 1032 + src/gen/docs/LogsApi.md | 108 + src/gen/docs/NetworkingApi.md | 57 + src/gen/docs/NetworkingV1Api.md | 4547 ++ src/gen/docs/NetworkingV1beta1Api.md | 1670 + src/gen/docs/NodeApi.md | 57 + src/gen/docs/NodeV1Api.md | 746 + src/gen/docs/OpenidApi.md | 57 + src/gen/docs/PolicyApi.md | 57 + src/gen/docs/PolicyV1Api.md | 1186 + src/gen/docs/RbacAuthorizationApi.md | 57 + src/gen/docs/RbacAuthorizationV1Api.md | 3029 ++ src/gen/docs/ResourceApi.md | 57 + src/gen/docs/ResourceV1Api.md | 4238 ++ src/gen/docs/ResourceV1alpha3Api.md | 1029 + src/gen/docs/ResourceV1beta1Api.md | 4232 ++ src/gen/docs/ResourceV1beta2Api.md | 4238 ++ src/gen/docs/SchedulingApi.md | 57 + src/gen/docs/SchedulingV1Api.md | 714 + src/gen/docs/SchedulingV1alpha1Api.md | 848 + src/gen/docs/StorageApi.md | 57 + src/gen/docs/StorageV1Api.md | 5303 +++ src/gen/docs/StorageV1beta1Api.md | 714 + src/gen/docs/StoragemigrationApi.md | 57 + src/gen/docs/StoragemigrationV1beta1Api.md | 1011 + src/gen/docs/VersionApi.md | 57 + src/gen/docs/WellKnownApi.md | 57 + src/gen/http/http.ts | 7 + src/gen/tsconfig.json | 3 + 70 files changed, 143321 insertions(+), 68 deletions(-) create mode 100644 src/gen/docs/AdmissionregistrationApi.md create mode 100644 src/gen/docs/AdmissionregistrationV1Api.md create mode 100644 src/gen/docs/AdmissionregistrationV1alpha1Api.md create mode 100644 src/gen/docs/AdmissionregistrationV1beta1Api.md create mode 100644 src/gen/docs/ApiextensionsApi.md create mode 100644 src/gen/docs/ApiextensionsV1Api.md create mode 100644 src/gen/docs/ApiregistrationApi.md create mode 100644 src/gen/docs/ApiregistrationV1Api.md create mode 100644 src/gen/docs/ApisApi.md create mode 100644 src/gen/docs/AppsApi.md create mode 100644 src/gen/docs/AppsV1Api.md create mode 100644 src/gen/docs/AuthenticationApi.md create mode 100644 src/gen/docs/AuthenticationV1Api.md create mode 100644 src/gen/docs/AuthorizationApi.md create mode 100644 src/gen/docs/AuthorizationV1Api.md create mode 100644 src/gen/docs/AutoscalingApi.md create mode 100644 src/gen/docs/AutoscalingV1Api.md create mode 100644 src/gen/docs/AutoscalingV2Api.md create mode 100644 src/gen/docs/BatchApi.md create mode 100644 src/gen/docs/BatchV1Api.md create mode 100644 src/gen/docs/CertificatesApi.md create mode 100644 src/gen/docs/CertificatesV1Api.md create mode 100644 src/gen/docs/CertificatesV1alpha1Api.md create mode 100644 src/gen/docs/CertificatesV1beta1Api.md create mode 100644 src/gen/docs/CoordinationApi.md create mode 100644 src/gen/docs/CoordinationV1Api.md create mode 100644 src/gen/docs/CoordinationV1alpha2Api.md create mode 100644 src/gen/docs/CoordinationV1beta1Api.md create mode 100644 src/gen/docs/CoreApi.md create mode 100644 src/gen/docs/CoreV1Api.md create mode 100644 src/gen/docs/CustomObjectsApi.md create mode 100644 src/gen/docs/DiscoveryApi.md create mode 100644 src/gen/docs/DiscoveryV1Api.md create mode 100644 src/gen/docs/EventsApi.md create mode 100644 src/gen/docs/EventsV1Api.md create mode 100644 src/gen/docs/FlowcontrolApiserverApi.md create mode 100644 src/gen/docs/FlowcontrolApiserverV1Api.md create mode 100644 src/gen/docs/InternalApiserverApi.md create mode 100644 src/gen/docs/InternalApiserverV1alpha1Api.md create mode 100644 src/gen/docs/LogsApi.md create mode 100644 src/gen/docs/NetworkingApi.md create mode 100644 src/gen/docs/NetworkingV1Api.md create mode 100644 src/gen/docs/NetworkingV1beta1Api.md create mode 100644 src/gen/docs/NodeApi.md create mode 100644 src/gen/docs/NodeV1Api.md create mode 100644 src/gen/docs/OpenidApi.md create mode 100644 src/gen/docs/PolicyApi.md create mode 100644 src/gen/docs/PolicyV1Api.md create mode 100644 src/gen/docs/RbacAuthorizationApi.md create mode 100644 src/gen/docs/RbacAuthorizationV1Api.md create mode 100644 src/gen/docs/ResourceApi.md create mode 100644 src/gen/docs/ResourceV1Api.md create mode 100644 src/gen/docs/ResourceV1alpha3Api.md create mode 100644 src/gen/docs/ResourceV1beta1Api.md create mode 100644 src/gen/docs/ResourceV1beta2Api.md create mode 100644 src/gen/docs/SchedulingApi.md create mode 100644 src/gen/docs/SchedulingV1Api.md create mode 100644 src/gen/docs/SchedulingV1alpha1Api.md create mode 100644 src/gen/docs/StorageApi.md create mode 100644 src/gen/docs/StorageV1Api.md create mode 100644 src/gen/docs/StorageV1beta1Api.md create mode 100644 src/gen/docs/StoragemigrationApi.md create mode 100644 src/gen/docs/StoragemigrationV1beta1Api.md create mode 100644 src/gen/docs/VersionApi.md create mode 100644 src/gen/docs/WellKnownApi.md diff --git a/src/gen/.openapi-generator/COMMIT b/src/gen/.openapi-generator/COMMIT index a56708a808..2665a3427d 100644 --- a/src/gen/.openapi-generator/COMMIT +++ b/src/gen/.openapi-generator/COMMIT @@ -1,2 +1,2 @@ -Requested Commit/Tag : d06ed32df0a30fe12a1c7ba98722c12e867b6060 -Actual Commit : d06ed32df0a30fe12a1c7ba98722c12e867b6060 +Requested Commit/Tag : 6e0fe098f1d9631c696135c7a3c46e4b0dc9ab3f +Actual Commit : 6e0fe098f1d9631c696135c7a3c46e4b0dc9ab3f diff --git a/src/gen/.openapi-generator/FILES b/src/gen/.openapi-generator/FILES index dfc7afcc04..2d5e059de3 100644 --- a/src/gen/.openapi-generator/FILES +++ b/src/gen/.openapi-generator/FILES @@ -1,71 +1,6 @@ .gitattributes .gitignore -AdmissionregistrationApi.md -AdmissionregistrationV1Api.md -AdmissionregistrationV1alpha1Api.md -AdmissionregistrationV1beta1Api.md -ApiextensionsApi.md -ApiextensionsV1Api.md -ApiregistrationApi.md -ApiregistrationV1Api.md -ApisApi.md -AppsApi.md -AppsV1Api.md -AuthenticationApi.md -AuthenticationV1Api.md -AuthorizationApi.md -AuthorizationV1Api.md -AutoscalingApi.md -AutoscalingV1Api.md -AutoscalingV2Api.md -BatchApi.md -BatchV1Api.md -CertificatesApi.md -CertificatesV1Api.md -CertificatesV1alpha1Api.md -CertificatesV1beta1Api.md -CoordinationApi.md -CoordinationV1Api.md -CoordinationV1alpha2Api.md -CoordinationV1beta1Api.md -CoreApi.md -CoreV1Api.md -CustomObjectsApi.md -DiscoveryApi.md -DiscoveryV1Api.md -EventsApi.md -EventsV1Api.md -FlowcontrolApiserverApi.md -FlowcontrolApiserverV1Api.md -InternalApiserverApi.md -InternalApiserverV1alpha1Api.md -LogsApi.md -NetworkingApi.md -NetworkingV1Api.md -NetworkingV1beta1Api.md -NodeApi.md -NodeV1Api.md -OpenidApi.md -PolicyApi.md -PolicyV1Api.md README.md -RbacAuthorizationApi.md -RbacAuthorizationV1Api.md -ResourceApi.md -ResourceV1Api.md -ResourceV1alpha3Api.md -ResourceV1beta1Api.md -ResourceV1beta2Api.md -SchedulingApi.md -SchedulingV1Api.md -SchedulingV1alpha1Api.md -StorageApi.md -StorageV1Api.md -StorageV1beta1Api.md -StoragemigrationApi.md -StoragemigrationV1beta1Api.md -VersionApi.md -WellKnownApi.md apis/AdmissionregistrationApi.ts apis/AdmissionregistrationV1Api.ts apis/AdmissionregistrationV1alpha1Api.ts @@ -135,6 +70,71 @@ apis/baseapi.ts apis/exception.ts auth/auth.ts configuration.ts +docs/AdmissionregistrationApi.md +docs/AdmissionregistrationV1Api.md +docs/AdmissionregistrationV1alpha1Api.md +docs/AdmissionregistrationV1beta1Api.md +docs/ApiextensionsApi.md +docs/ApiextensionsV1Api.md +docs/ApiregistrationApi.md +docs/ApiregistrationV1Api.md +docs/ApisApi.md +docs/AppsApi.md +docs/AppsV1Api.md +docs/AuthenticationApi.md +docs/AuthenticationV1Api.md +docs/AuthorizationApi.md +docs/AuthorizationV1Api.md +docs/AutoscalingApi.md +docs/AutoscalingV1Api.md +docs/AutoscalingV2Api.md +docs/BatchApi.md +docs/BatchV1Api.md +docs/CertificatesApi.md +docs/CertificatesV1Api.md +docs/CertificatesV1alpha1Api.md +docs/CertificatesV1beta1Api.md +docs/CoordinationApi.md +docs/CoordinationV1Api.md +docs/CoordinationV1alpha2Api.md +docs/CoordinationV1beta1Api.md +docs/CoreApi.md +docs/CoreV1Api.md +docs/CustomObjectsApi.md +docs/DiscoveryApi.md +docs/DiscoveryV1Api.md +docs/EventsApi.md +docs/EventsV1Api.md +docs/FlowcontrolApiserverApi.md +docs/FlowcontrolApiserverV1Api.md +docs/InternalApiserverApi.md +docs/InternalApiserverV1alpha1Api.md +docs/LogsApi.md +docs/NetworkingApi.md +docs/NetworkingV1Api.md +docs/NetworkingV1beta1Api.md +docs/NodeApi.md +docs/NodeV1Api.md +docs/OpenidApi.md +docs/PolicyApi.md +docs/PolicyV1Api.md +docs/RbacAuthorizationApi.md +docs/RbacAuthorizationV1Api.md +docs/ResourceApi.md +docs/ResourceV1Api.md +docs/ResourceV1alpha3Api.md +docs/ResourceV1beta1Api.md +docs/ResourceV1beta2Api.md +docs/SchedulingApi.md +docs/SchedulingV1Api.md +docs/SchedulingV1alpha1Api.md +docs/StorageApi.md +docs/StorageV1Api.md +docs/StorageV1beta1Api.md +docs/StoragemigrationApi.md +docs/StoragemigrationV1beta1Api.md +docs/VersionApi.md +docs/WellKnownApi.md git_push.sh http/http.ts http/isomorphic-fetch.ts diff --git a/src/gen/.openapi-generator/VERSION b/src/gen/.openapi-generator/VERSION index fc74d6ceba..2fb556b606 100644 --- a/src/gen/.openapi-generator/VERSION +++ b/src/gen/.openapi-generator/VERSION @@ -1 +1 @@ -7.15.0-SNAPSHOT +7.18.0-SNAPSHOT diff --git a/src/gen/docs/AdmissionregistrationApi.md b/src/gen/docs/AdmissionregistrationApi.md new file mode 100644 index 0000000000..fdf3930721 --- /dev/null +++ b/src/gen/docs/AdmissionregistrationApi.md @@ -0,0 +1,57 @@ +# .AdmissionregistrationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](AdmissionregistrationApi.md#getAPIGroup) | **GET** /apis/admissionregistration.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AdmissionregistrationV1Api.md b/src/gen/docs/AdmissionregistrationV1Api.md new file mode 100644 index 0000000000..75db144deb --- /dev/null +++ b/src/gen/docs/AdmissionregistrationV1Api.md @@ -0,0 +1,3762 @@ +# .AdmissionregistrationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#createMutatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | +[**createValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#createValidatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | +[**createValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#createValidatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | +[**createValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#createValidatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | +[**deleteCollectionMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#deleteCollectionMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | +[**deleteCollectionValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#deleteCollectionValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | +[**deleteCollectionValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#deleteCollectionValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | +[**deleteCollectionValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#deleteCollectionValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | +[**deleteMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#deleteMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**deleteValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#deleteValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**deleteValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#deleteValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**deleteValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#deleteValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | +[**getAPIResources**](AdmissionregistrationV1Api.md#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1/ | +[**listMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#listMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | +[**listValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#listValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | +[**listValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#listValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | +[**listValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#listValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | +[**patchMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#patchMutatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**patchValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#patchValidatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**patchValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#patchValidatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**patchValidatingAdmissionPolicyStatus**](AdmissionregistrationV1Api.md#patchValidatingAdmissionPolicyStatus) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | +[**patchValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#patchValidatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | +[**readMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#readMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**readValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#readValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**readValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#readValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**readValidatingAdmissionPolicyStatus**](AdmissionregistrationV1Api.md#readValidatingAdmissionPolicyStatus) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | +[**readValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#readValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | +[**replaceMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#replaceMutatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**replaceValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#replaceValidatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**replaceValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#replaceValidatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**replaceValidatingAdmissionPolicyStatus**](AdmissionregistrationV1Api.md#replaceValidatingAdmissionPolicyStatus) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | +[**replaceValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#replaceValidatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | + + +# **createMutatingWebhookConfiguration** +> V1MutatingWebhookConfiguration createMutatingWebhookConfiguration(body) + +create a MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + reinvocationPolicy: "reinvocationPolicy_example", + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1MutatingWebhookConfiguration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1MutatingWebhookConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createValidatingAdmissionPolicy** +> V1ValidatingAdmissionPolicy createValidatingAdmissionPolicy(body) + +create a ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + auditAnnotations: [ + { + key: "key_example", + valueExpression: "valueExpression_example", + }, + ], + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + validations: [ + { + expression: "expression_example", + message: "message_example", + messageExpression: "messageExpression_example", + reason: "reason_example", + }, + ], + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + typeChecking: { + expressionWarnings: [ + { + fieldRef: "fieldRef_example", + warning: "warning_example", + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicy**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createValidatingAdmissionPolicyBinding** +> V1ValidatingAdmissionPolicyBinding createValidatingAdmissionPolicyBinding(body) + +create a ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + validationActions: [ + "validationActions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicyBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createValidatingWebhookConfiguration** +> V1ValidatingWebhookConfiguration createValidatingWebhookConfiguration(body) + +create a ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingWebhookConfiguration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingWebhookConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionMutatingWebhookConfiguration** +> V1Status deleteCollectionMutatingWebhookConfiguration() + +delete collection of MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionValidatingAdmissionPolicy** +> V1Status deleteCollectionValidatingAdmissionPolicy() + +delete collection of ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionValidatingAdmissionPolicyBinding** +> V1Status deleteCollectionValidatingAdmissionPolicyBinding() + +delete collection of ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionValidatingWebhookConfiguration** +> V1Status deleteCollectionValidatingWebhookConfiguration() + +delete collection of ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteMutatingWebhookConfiguration** +> V1Status deleteMutatingWebhookConfiguration() + +delete a MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteValidatingAdmissionPolicy** +> V1Status deleteValidatingAdmissionPolicy() + +delete a ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteValidatingAdmissionPolicyBinding** +> V1Status deleteValidatingAdmissionPolicyBinding() + +delete a ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteValidatingWebhookConfiguration** +> V1Status deleteValidatingWebhookConfiguration() + +delete a ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listMutatingWebhookConfiguration** +> V1MutatingWebhookConfigurationList listMutatingWebhookConfiguration() + +list or watch objects of kind MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1MutatingWebhookConfigurationList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listValidatingAdmissionPolicy** +> V1ValidatingAdmissionPolicyList listValidatingAdmissionPolicy() + +list or watch objects of kind ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicyList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listValidatingAdmissionPolicyBinding** +> V1ValidatingAdmissionPolicyBindingList listValidatingAdmissionPolicyBinding() + +list or watch objects of kind ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicyBindingList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listValidatingWebhookConfiguration** +> V1ValidatingWebhookConfigurationList listValidatingWebhookConfiguration() + +list or watch objects of kind ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingWebhookConfigurationList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchMutatingWebhookConfiguration** +> V1MutatingWebhookConfiguration patchMutatingWebhookConfiguration(body) + +partially update the specified MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1MutatingWebhookConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchValidatingAdmissionPolicy** +> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicy(body) + +partially update the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchValidatingAdmissionPolicyBinding** +> V1ValidatingAdmissionPolicyBinding patchValidatingAdmissionPolicyBinding(body) + +partially update the specified ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchValidatingAdmissionPolicyStatus** +> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicyStatus(body) + +partially update status of the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingAdmissionPolicyStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchValidatingWebhookConfiguration** +> V1ValidatingWebhookConfiguration patchValidatingWebhookConfiguration(body) + +partially update the specified ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingWebhookConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readMutatingWebhookConfiguration** +> V1MutatingWebhookConfiguration readMutatingWebhookConfiguration() + +read the specified MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1MutatingWebhookConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readValidatingAdmissionPolicy** +> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicy() + +read the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readValidatingAdmissionPolicyBinding** +> V1ValidatingAdmissionPolicyBinding readValidatingAdmissionPolicyBinding() + +read the specified ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readValidatingAdmissionPolicyStatus** +> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicyStatus() + +read status of the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingAdmissionPolicyStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readValidatingWebhookConfiguration** +> V1ValidatingWebhookConfiguration readValidatingWebhookConfiguration() + +read the specified ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ValidatingWebhookConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceMutatingWebhookConfiguration** +> V1MutatingWebhookConfiguration replaceMutatingWebhookConfiguration(body) + +replace the specified MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + reinvocationPolicy: "reinvocationPolicy_example", + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1MutatingWebhookConfiguration**| | + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1MutatingWebhookConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceValidatingAdmissionPolicy** +> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicy(body) + +replace the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + auditAnnotations: [ + { + key: "key_example", + valueExpression: "valueExpression_example", + }, + ], + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + validations: [ + { + expression: "expression_example", + message: "message_example", + messageExpression: "messageExpression_example", + reason: "reason_example", + }, + ], + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + typeChecking: { + expressionWarnings: [ + { + fieldRef: "fieldRef_example", + warning: "warning_example", + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicy**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceValidatingAdmissionPolicyBinding** +> V1ValidatingAdmissionPolicyBinding replaceValidatingAdmissionPolicyBinding(body) + +replace the specified ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + validationActions: [ + "validationActions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicyBinding**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceValidatingAdmissionPolicyStatus** +> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicyStatus(body) + +replace status of the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + auditAnnotations: [ + { + key: "key_example", + valueExpression: "valueExpression_example", + }, + ], + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + validations: [ + { + expression: "expression_example", + message: "message_example", + messageExpression: "messageExpression_example", + reason: "reason_example", + }, + ], + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + typeChecking: { + expressionWarnings: [ + { + fieldRef: "fieldRef_example", + warning: "warning_example", + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingAdmissionPolicyStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicy**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceValidatingWebhookConfiguration** +> V1ValidatingWebhookConfiguration replaceValidatingWebhookConfiguration(body) + +replace the specified ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from ''; +import type { AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingWebhookConfiguration**| | + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ValidatingWebhookConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AdmissionregistrationV1alpha1Api.md b/src/gen/docs/AdmissionregistrationV1alpha1Api.md new file mode 100644 index 0000000000..e256036b3b --- /dev/null +++ b/src/gen/docs/AdmissionregistrationV1alpha1Api.md @@ -0,0 +1,1745 @@ +# .AdmissionregistrationV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | +[**createMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | +[**deleteCollectionMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | +[**deleteCollectionMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | +[**deleteMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**deleteMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | +[**getAPIResources**](AdmissionregistrationV1alpha1Api.md#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/ | +[**listMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | +[**listMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | +[**patchMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**patchMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | +[**readMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**readMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | +[**replaceMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**replaceMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | + + +# **createMutatingAdmissionPolicy** +> V1alpha1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) + +create a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicy**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1MutatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createMutatingAdmissionPolicyBinding** +> V1alpha1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) + +create a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1MutatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionMutatingAdmissionPolicy** +> V1Status deleteCollectionMutatingAdmissionPolicy() + +delete collection of MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionMutatingAdmissionPolicyBinding** +> V1Status deleteCollectionMutatingAdmissionPolicyBinding() + +delete collection of MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteMutatingAdmissionPolicy** +> V1Status deleteMutatingAdmissionPolicy() + +delete a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteMutatingAdmissionPolicyBinding** +> V1Status deleteMutatingAdmissionPolicyBinding() + +delete a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listMutatingAdmissionPolicy** +> V1alpha1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() + +list or watch objects of kind MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1alpha1MutatingAdmissionPolicyList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listMutatingAdmissionPolicyBinding** +> V1alpha1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() + +list or watch objects of kind MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1alpha1MutatingAdmissionPolicyBindingList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchMutatingAdmissionPolicy** +> V1alpha1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) + +partially update the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1alpha1MutatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchMutatingAdmissionPolicyBinding** +> V1alpha1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) + +partially update the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1alpha1MutatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readMutatingAdmissionPolicy** +> V1alpha1MutatingAdmissionPolicy readMutatingAdmissionPolicy() + +read the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1alpha1MutatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readMutatingAdmissionPolicyBinding** +> V1alpha1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() + +read the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1alpha1MutatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceMutatingAdmissionPolicy** +> V1alpha1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) + +replace the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicy**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1MutatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceMutatingAdmissionPolicyBinding** +> V1alpha1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) + +replace the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; +import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1MutatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AdmissionregistrationV1beta1Api.md b/src/gen/docs/AdmissionregistrationV1beta1Api.md new file mode 100644 index 0000000000..41b35289ea --- /dev/null +++ b/src/gen/docs/AdmissionregistrationV1beta1Api.md @@ -0,0 +1,1745 @@ +# .AdmissionregistrationV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | +[**createMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | +[**deleteCollectionMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | +[**deleteCollectionMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | +[**deleteMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**deleteMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | +[**getAPIResources**](AdmissionregistrationV1beta1Api.md#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1beta1/ | +[**listMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | +[**listMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | +[**patchMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**patchMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | +[**readMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**readMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | +[**replaceMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**replaceMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | + + +# **createMutatingAdmissionPolicy** +> V1beta1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) + +create a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicy**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1MutatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createMutatingAdmissionPolicyBinding** +> V1beta1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) + +create a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicyBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1MutatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionMutatingAdmissionPolicy** +> V1Status deleteCollectionMutatingAdmissionPolicy() + +delete collection of MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionMutatingAdmissionPolicyBinding** +> V1Status deleteCollectionMutatingAdmissionPolicyBinding() + +delete collection of MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteMutatingAdmissionPolicy** +> V1Status deleteMutatingAdmissionPolicy() + +delete a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteMutatingAdmissionPolicyBinding** +> V1Status deleteMutatingAdmissionPolicyBinding() + +delete a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listMutatingAdmissionPolicy** +> V1beta1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() + +list or watch objects of kind MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1MutatingAdmissionPolicyList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listMutatingAdmissionPolicyBinding** +> V1beta1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() + +list or watch objects of kind MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1MutatingAdmissionPolicyBindingList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchMutatingAdmissionPolicy** +> V1beta1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) + +partially update the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1MutatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchMutatingAdmissionPolicyBinding** +> V1beta1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) + +partially update the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1MutatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readMutatingAdmissionPolicy** +> V1beta1MutatingAdmissionPolicy readMutatingAdmissionPolicy() + +read the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1MutatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readMutatingAdmissionPolicyBinding** +> V1beta1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() + +read the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1MutatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceMutatingAdmissionPolicy** +> V1beta1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) + +replace the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicy**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1MutatingAdmissionPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceMutatingAdmissionPolicyBinding** +> V1beta1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) + +replace the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; +import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicyBinding**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1MutatingAdmissionPolicyBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/ApiextensionsApi.md b/src/gen/docs/ApiextensionsApi.md new file mode 100644 index 0000000000..14d9d5ba49 --- /dev/null +++ b/src/gen/docs/ApiextensionsApi.md @@ -0,0 +1,57 @@ +# .ApiextensionsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](ApiextensionsApi.md#getAPIGroup) | **GET** /apis/apiextensions.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, ApiextensionsApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/ApiextensionsV1Api.md b/src/gen/docs/ApiextensionsV1Api.md new file mode 100644 index 0000000000..1547e08d2d --- /dev/null +++ b/src/gen/docs/ApiextensionsV1Api.md @@ -0,0 +1,1479 @@ +# .ApiextensionsV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createCustomResourceDefinition**](ApiextensionsV1Api.md#createCustomResourceDefinition) | **POST** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | +[**deleteCollectionCustomResourceDefinition**](ApiextensionsV1Api.md#deleteCollectionCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | +[**deleteCustomResourceDefinition**](ApiextensionsV1Api.md#deleteCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**getAPIResources**](ApiextensionsV1Api.md#getAPIResources) | **GET** /apis/apiextensions.k8s.io/v1/ | +[**listCustomResourceDefinition**](ApiextensionsV1Api.md#listCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | +[**patchCustomResourceDefinition**](ApiextensionsV1Api.md#patchCustomResourceDefinition) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**patchCustomResourceDefinitionStatus**](ApiextensionsV1Api.md#patchCustomResourceDefinitionStatus) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | +[**readCustomResourceDefinition**](ApiextensionsV1Api.md#readCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**readCustomResourceDefinitionStatus**](ApiextensionsV1Api.md#readCustomResourceDefinitionStatus) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | +[**replaceCustomResourceDefinition**](ApiextensionsV1Api.md#replaceCustomResourceDefinition) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**replaceCustomResourceDefinitionStatus**](ApiextensionsV1Api.md#replaceCustomResourceDefinitionStatus) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | + + +# **createCustomResourceDefinition** +> V1CustomResourceDefinition createCustomResourceDefinition(body) + +create a CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; +import type { ApiextensionsV1ApiCreateCustomResourceDefinitionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiCreateCustomResourceDefinitionRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + conversion: { + strategy: "strategy_example", + webhook: { + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + conversionReviewVersions: [ + "conversionReviewVersions_example", + ], + }, + }, + group: "group_example", + names: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + preserveUnknownFields: true, + scope: "scope_example", + versions: [ + { + additionalPrinterColumns: [ + { + description: "description_example", + format: "format_example", + jsonPath: "jsonPath_example", + name: "name_example", + priority: 1, + type: "type_example", + }, + ], + deprecated: true, + deprecationWarning: "deprecationWarning_example", + name: "name_example", + schema: { + openAPIV3Schema: { + ref: "ref_example", + schema: "schema_example", + additionalItems: {}, + additionalProperties: {}, + allOf: [ + , + ], + anyOf: [ + , + ], + _default: {}, + definitions: { + "key": , + }, + dependencies: { + "key": {}, + }, + description: "description_example", + _enum: [ + {}, + ], + example: {}, + exclusiveMaximum: true, + exclusiveMinimum: true, + externalDocs: { + description: "description_example", + url: "url_example", + }, + format: "format_example", + id: "id_example", + items: {}, + maxItems: 1, + maxLength: 1, + maxProperties: 1, + maximum: 3.14, + minItems: 1, + minLength: 1, + minProperties: 1, + minimum: 3.14, + multipleOf: 3.14, + not: , + nullable: true, + oneOf: [ + , + ], + pattern: "pattern_example", + patternProperties: { + "key": , + }, + properties: { + "key": , + }, + required: [ + "required_example", + ], + title: "title_example", + type: "type_example", + uniqueItems: true, + x_kubernetes_embedded_resource: true, + x_kubernetes_int_or_string: true, + x_kubernetes_list_map_keys: [ + "x_kubernetes_list_map_keys_example", + ], + x_kubernetes_list_type: "x_kubernetes_list_type_example", + x_kubernetes_map_type: "x_kubernetes_map_type_example", + x_kubernetes_preserve_unknown_fields: true, + x_kubernetes_validations: [ + { + fieldPath: "fieldPath_example", + message: "message_example", + messageExpression: "messageExpression_example", + optionalOldSelf: true, + reason: "reason_example", + rule: "rule_example", + }, + ], + }, + }, + selectableFields: [ + { + jsonPath: "jsonPath_example", + }, + ], + served: true, + storage: true, + subresources: { + scale: { + labelSelectorPath: "labelSelectorPath_example", + specReplicasPath: "specReplicasPath_example", + statusReplicasPath: "statusReplicasPath_example", + }, + status: {}, + }, + }, + ], + }, + status: { + acceptedNames: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + storedVersions: [ + "storedVersions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CustomResourceDefinition**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CustomResourceDefinition** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionCustomResourceDefinition** +> V1Status deleteCollectionCustomResourceDefinition() + +delete collection of CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; +import type { ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCustomResourceDefinition** +> V1Status deleteCustomResourceDefinition() + +delete a CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; +import type { ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listCustomResourceDefinition** +> V1CustomResourceDefinitionList listCustomResourceDefinition() + +list or watch objects of kind CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; +import type { ApiextensionsV1ApiListCustomResourceDefinitionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiListCustomResourceDefinitionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1CustomResourceDefinitionList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchCustomResourceDefinition** +> V1CustomResourceDefinition patchCustomResourceDefinition(body) + +partially update the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; +import type { ApiextensionsV1ApiPatchCustomResourceDefinitionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiPatchCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1CustomResourceDefinition** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchCustomResourceDefinitionStatus** +> V1CustomResourceDefinition patchCustomResourceDefinitionStatus(body) + +partially update status of the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; +import type { ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCustomResourceDefinitionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1CustomResourceDefinition** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readCustomResourceDefinition** +> V1CustomResourceDefinition readCustomResourceDefinition() + +read the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; +import type { ApiextensionsV1ApiReadCustomResourceDefinitionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReadCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1CustomResourceDefinition** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readCustomResourceDefinitionStatus** +> V1CustomResourceDefinition readCustomResourceDefinitionStatus() + +read status of the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; +import type { ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest = { + // name of the CustomResourceDefinition + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCustomResourceDefinitionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1CustomResourceDefinition** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceCustomResourceDefinition** +> V1CustomResourceDefinition replaceCustomResourceDefinition(body) + +replace the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; +import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + conversion: { + strategy: "strategy_example", + webhook: { + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + conversionReviewVersions: [ + "conversionReviewVersions_example", + ], + }, + }, + group: "group_example", + names: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + preserveUnknownFields: true, + scope: "scope_example", + versions: [ + { + additionalPrinterColumns: [ + { + description: "description_example", + format: "format_example", + jsonPath: "jsonPath_example", + name: "name_example", + priority: 1, + type: "type_example", + }, + ], + deprecated: true, + deprecationWarning: "deprecationWarning_example", + name: "name_example", + schema: { + openAPIV3Schema: { + ref: "ref_example", + schema: "schema_example", + additionalItems: {}, + additionalProperties: {}, + allOf: [ + , + ], + anyOf: [ + , + ], + _default: {}, + definitions: { + "key": , + }, + dependencies: { + "key": {}, + }, + description: "description_example", + _enum: [ + {}, + ], + example: {}, + exclusiveMaximum: true, + exclusiveMinimum: true, + externalDocs: { + description: "description_example", + url: "url_example", + }, + format: "format_example", + id: "id_example", + items: {}, + maxItems: 1, + maxLength: 1, + maxProperties: 1, + maximum: 3.14, + minItems: 1, + minLength: 1, + minProperties: 1, + minimum: 3.14, + multipleOf: 3.14, + not: , + nullable: true, + oneOf: [ + , + ], + pattern: "pattern_example", + patternProperties: { + "key": , + }, + properties: { + "key": , + }, + required: [ + "required_example", + ], + title: "title_example", + type: "type_example", + uniqueItems: true, + x_kubernetes_embedded_resource: true, + x_kubernetes_int_or_string: true, + x_kubernetes_list_map_keys: [ + "x_kubernetes_list_map_keys_example", + ], + x_kubernetes_list_type: "x_kubernetes_list_type_example", + x_kubernetes_map_type: "x_kubernetes_map_type_example", + x_kubernetes_preserve_unknown_fields: true, + x_kubernetes_validations: [ + { + fieldPath: "fieldPath_example", + message: "message_example", + messageExpression: "messageExpression_example", + optionalOldSelf: true, + reason: "reason_example", + rule: "rule_example", + }, + ], + }, + }, + selectableFields: [ + { + jsonPath: "jsonPath_example", + }, + ], + served: true, + storage: true, + subresources: { + scale: { + labelSelectorPath: "labelSelectorPath_example", + specReplicasPath: "specReplicasPath_example", + statusReplicasPath: "statusReplicasPath_example", + }, + status: {}, + }, + }, + ], + }, + status: { + acceptedNames: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + storedVersions: [ + "storedVersions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CustomResourceDefinition**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CustomResourceDefinition** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceCustomResourceDefinitionStatus** +> V1CustomResourceDefinition replaceCustomResourceDefinitionStatus(body) + +replace status of the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from ''; +import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + conversion: { + strategy: "strategy_example", + webhook: { + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + conversionReviewVersions: [ + "conversionReviewVersions_example", + ], + }, + }, + group: "group_example", + names: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + preserveUnknownFields: true, + scope: "scope_example", + versions: [ + { + additionalPrinterColumns: [ + { + description: "description_example", + format: "format_example", + jsonPath: "jsonPath_example", + name: "name_example", + priority: 1, + type: "type_example", + }, + ], + deprecated: true, + deprecationWarning: "deprecationWarning_example", + name: "name_example", + schema: { + openAPIV3Schema: { + ref: "ref_example", + schema: "schema_example", + additionalItems: {}, + additionalProperties: {}, + allOf: [ + , + ], + anyOf: [ + , + ], + _default: {}, + definitions: { + "key": , + }, + dependencies: { + "key": {}, + }, + description: "description_example", + _enum: [ + {}, + ], + example: {}, + exclusiveMaximum: true, + exclusiveMinimum: true, + externalDocs: { + description: "description_example", + url: "url_example", + }, + format: "format_example", + id: "id_example", + items: {}, + maxItems: 1, + maxLength: 1, + maxProperties: 1, + maximum: 3.14, + minItems: 1, + minLength: 1, + minProperties: 1, + minimum: 3.14, + multipleOf: 3.14, + not: , + nullable: true, + oneOf: [ + , + ], + pattern: "pattern_example", + patternProperties: { + "key": , + }, + properties: { + "key": , + }, + required: [ + "required_example", + ], + title: "title_example", + type: "type_example", + uniqueItems: true, + x_kubernetes_embedded_resource: true, + x_kubernetes_int_or_string: true, + x_kubernetes_list_map_keys: [ + "x_kubernetes_list_map_keys_example", + ], + x_kubernetes_list_type: "x_kubernetes_list_type_example", + x_kubernetes_map_type: "x_kubernetes_map_type_example", + x_kubernetes_preserve_unknown_fields: true, + x_kubernetes_validations: [ + { + fieldPath: "fieldPath_example", + message: "message_example", + messageExpression: "messageExpression_example", + optionalOldSelf: true, + reason: "reason_example", + rule: "rule_example", + }, + ], + }, + }, + selectableFields: [ + { + jsonPath: "jsonPath_example", + }, + ], + served: true, + storage: true, + subresources: { + scale: { + labelSelectorPath: "labelSelectorPath_example", + specReplicasPath: "specReplicasPath_example", + statusReplicasPath: "statusReplicasPath_example", + }, + status: {}, + }, + }, + ], + }, + status: { + acceptedNames: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + storedVersions: [ + "storedVersions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCustomResourceDefinitionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CustomResourceDefinition**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CustomResourceDefinition** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/ApiregistrationApi.md b/src/gen/docs/ApiregistrationApi.md new file mode 100644 index 0000000000..4eadbdb578 --- /dev/null +++ b/src/gen/docs/ApiregistrationApi.md @@ -0,0 +1,57 @@ +# .ApiregistrationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](ApiregistrationApi.md#getAPIGroup) | **GET** /apis/apiregistration.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, ApiregistrationApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/ApiregistrationV1Api.md b/src/gen/docs/ApiregistrationV1Api.md new file mode 100644 index 0000000000..12530bc672 --- /dev/null +++ b/src/gen/docs/ApiregistrationV1Api.md @@ -0,0 +1,1026 @@ +# .ApiregistrationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createAPIService**](ApiregistrationV1Api.md#createAPIService) | **POST** /apis/apiregistration.k8s.io/v1/apiservices | +[**deleteAPIService**](ApiregistrationV1Api.md#deleteAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**deleteCollectionAPIService**](ApiregistrationV1Api.md#deleteCollectionAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices | +[**getAPIResources**](ApiregistrationV1Api.md#getAPIResources) | **GET** /apis/apiregistration.k8s.io/v1/ | +[**listAPIService**](ApiregistrationV1Api.md#listAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices | +[**patchAPIService**](ApiregistrationV1Api.md#patchAPIService) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**patchAPIServiceStatus**](ApiregistrationV1Api.md#patchAPIServiceStatus) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | +[**readAPIService**](ApiregistrationV1Api.md#readAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**readAPIServiceStatus**](ApiregistrationV1Api.md#readAPIServiceStatus) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | +[**replaceAPIService**](ApiregistrationV1Api.md#replaceAPIService) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**replaceAPIServiceStatus**](ApiregistrationV1Api.md#replaceAPIServiceStatus) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | + + +# **createAPIService** +> V1APIService createAPIService(body) + +create an APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; +import type { ApiregistrationV1ApiCreateAPIServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiCreateAPIServiceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + caBundle: 'YQ==', + group: "group_example", + groupPriorityMinimum: 1, + insecureSkipTLSVerify: true, + service: { + name: "name_example", + namespace: "namespace_example", + port: 1, + }, + version: "version_example", + versionPriority: 1, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1APIService**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1APIService** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteAPIService** +> V1Status deleteAPIService() + +delete an APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; +import type { ApiregistrationV1ApiDeleteAPIServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiDeleteAPIServiceRequest = { + // name of the APIService + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionAPIService** +> V1Status deleteCollectionAPIService() + +delete collection of APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; +import type { ApiregistrationV1ApiDeleteCollectionAPIServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiDeleteCollectionAPIServiceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listAPIService** +> V1APIServiceList listAPIService() + +list or watch objects of kind APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; +import type { ApiregistrationV1ApiListAPIServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiListAPIServiceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1APIServiceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchAPIService** +> V1APIService patchAPIService(body) + +partially update the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; +import type { ApiregistrationV1ApiPatchAPIServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiPatchAPIServiceRequest = { + // name of the APIService + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1APIService** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchAPIServiceStatus** +> V1APIService patchAPIServiceStatus(body) + +partially update status of the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; +import type { ApiregistrationV1ApiPatchAPIServiceStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiPatchAPIServiceStatusRequest = { + // name of the APIService + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchAPIServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1APIService** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readAPIService** +> V1APIService readAPIService() + +read the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; +import type { ApiregistrationV1ApiReadAPIServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReadAPIServiceRequest = { + // name of the APIService + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1APIService** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readAPIServiceStatus** +> V1APIService readAPIServiceStatus() + +read status of the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; +import type { ApiregistrationV1ApiReadAPIServiceStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReadAPIServiceStatusRequest = { + // name of the APIService + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readAPIServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1APIService** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceAPIService** +> V1APIService replaceAPIService(body) + +replace the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; +import type { ApiregistrationV1ApiReplaceAPIServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReplaceAPIServiceRequest = { + // name of the APIService + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + caBundle: 'YQ==', + group: "group_example", + groupPriorityMinimum: 1, + insecureSkipTLSVerify: true, + service: { + name: "name_example", + namespace: "namespace_example", + port: 1, + }, + version: "version_example", + versionPriority: 1, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1APIService**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1APIService** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceAPIServiceStatus** +> V1APIService replaceAPIServiceStatus(body) + +replace status of the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from ''; +import type { ApiregistrationV1ApiReplaceAPIServiceStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReplaceAPIServiceStatusRequest = { + // name of the APIService + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + caBundle: 'YQ==', + group: "group_example", + groupPriorityMinimum: 1, + insecureSkipTLSVerify: true, + service: { + name: "name_example", + namespace: "namespace_example", + port: 1, + }, + version: "version_example", + versionPriority: 1, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceAPIServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1APIService**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1APIService** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/ApisApi.md b/src/gen/docs/ApisApi.md new file mode 100644 index 0000000000..d7ffff7a76 --- /dev/null +++ b/src/gen/docs/ApisApi.md @@ -0,0 +1,57 @@ +# .ApisApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIVersions**](ApisApi.md#getAPIVersions) | **GET** /apis/ | + + +# **getAPIVersions** +> V1APIGroupList getAPIVersions() + +get available API versions + +### Example + + +```typescript +import { createConfiguration, ApisApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ApisApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIVersions(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroupList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AppsApi.md b/src/gen/docs/AppsApi.md new file mode 100644 index 0000000000..cbf30ffb12 --- /dev/null +++ b/src/gen/docs/AppsApi.md @@ -0,0 +1,57 @@ +# .AppsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](AppsApi.md#getAPIGroup) | **GET** /apis/apps/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AppsApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AppsV1Api.md b/src/gen/docs/AppsV1Api.md new file mode 100644 index 0000000000..96ce980868 --- /dev/null +++ b/src/gen/docs/AppsV1Api.md @@ -0,0 +1,28117 @@ +# .AppsV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedControllerRevision**](AppsV1Api.md#createNamespacedControllerRevision) | **POST** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | +[**createNamespacedDaemonSet**](AppsV1Api.md#createNamespacedDaemonSet) | **POST** /apis/apps/v1/namespaces/{namespace}/daemonsets | +[**createNamespacedDeployment**](AppsV1Api.md#createNamespacedDeployment) | **POST** /apis/apps/v1/namespaces/{namespace}/deployments | +[**createNamespacedReplicaSet**](AppsV1Api.md#createNamespacedReplicaSet) | **POST** /apis/apps/v1/namespaces/{namespace}/replicasets | +[**createNamespacedStatefulSet**](AppsV1Api.md#createNamespacedStatefulSet) | **POST** /apis/apps/v1/namespaces/{namespace}/statefulsets | +[**deleteCollectionNamespacedControllerRevision**](AppsV1Api.md#deleteCollectionNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | +[**deleteCollectionNamespacedDaemonSet**](AppsV1Api.md#deleteCollectionNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets | +[**deleteCollectionNamespacedDeployment**](AppsV1Api.md#deleteCollectionNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments | +[**deleteCollectionNamespacedReplicaSet**](AppsV1Api.md#deleteCollectionNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets | +[**deleteCollectionNamespacedStatefulSet**](AppsV1Api.md#deleteCollectionNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets | +[**deleteNamespacedControllerRevision**](AppsV1Api.md#deleteNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**deleteNamespacedDaemonSet**](AppsV1Api.md#deleteNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**deleteNamespacedDeployment**](AppsV1Api.md#deleteNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**deleteNamespacedReplicaSet**](AppsV1Api.md#deleteNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**deleteNamespacedStatefulSet**](AppsV1Api.md#deleteNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**getAPIResources**](AppsV1Api.md#getAPIResources) | **GET** /apis/apps/v1/ | +[**listControllerRevisionForAllNamespaces**](AppsV1Api.md#listControllerRevisionForAllNamespaces) | **GET** /apis/apps/v1/controllerrevisions | +[**listDaemonSetForAllNamespaces**](AppsV1Api.md#listDaemonSetForAllNamespaces) | **GET** /apis/apps/v1/daemonsets | +[**listDeploymentForAllNamespaces**](AppsV1Api.md#listDeploymentForAllNamespaces) | **GET** /apis/apps/v1/deployments | +[**listNamespacedControllerRevision**](AppsV1Api.md#listNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | +[**listNamespacedDaemonSet**](AppsV1Api.md#listNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets | +[**listNamespacedDeployment**](AppsV1Api.md#listNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments | +[**listNamespacedReplicaSet**](AppsV1Api.md#listNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets | +[**listNamespacedStatefulSet**](AppsV1Api.md#listNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets | +[**listReplicaSetForAllNamespaces**](AppsV1Api.md#listReplicaSetForAllNamespaces) | **GET** /apis/apps/v1/replicasets | +[**listStatefulSetForAllNamespaces**](AppsV1Api.md#listStatefulSetForAllNamespaces) | **GET** /apis/apps/v1/statefulsets | +[**patchNamespacedControllerRevision**](AppsV1Api.md#patchNamespacedControllerRevision) | **PATCH** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**patchNamespacedDaemonSet**](AppsV1Api.md#patchNamespacedDaemonSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**patchNamespacedDaemonSetStatus**](AppsV1Api.md#patchNamespacedDaemonSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | +[**patchNamespacedDeployment**](AppsV1Api.md#patchNamespacedDeployment) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**patchNamespacedDeploymentScale**](AppsV1Api.md#patchNamespacedDeploymentScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | +[**patchNamespacedDeploymentStatus**](AppsV1Api.md#patchNamespacedDeploymentStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | +[**patchNamespacedReplicaSet**](AppsV1Api.md#patchNamespacedReplicaSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**patchNamespacedReplicaSetScale**](AppsV1Api.md#patchNamespacedReplicaSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | +[**patchNamespacedReplicaSetStatus**](AppsV1Api.md#patchNamespacedReplicaSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | +[**patchNamespacedStatefulSet**](AppsV1Api.md#patchNamespacedStatefulSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**patchNamespacedStatefulSetScale**](AppsV1Api.md#patchNamespacedStatefulSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | +[**patchNamespacedStatefulSetStatus**](AppsV1Api.md#patchNamespacedStatefulSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | +[**readNamespacedControllerRevision**](AppsV1Api.md#readNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**readNamespacedDaemonSet**](AppsV1Api.md#readNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**readNamespacedDaemonSetStatus**](AppsV1Api.md#readNamespacedDaemonSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | +[**readNamespacedDeployment**](AppsV1Api.md#readNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**readNamespacedDeploymentScale**](AppsV1Api.md#readNamespacedDeploymentScale) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | +[**readNamespacedDeploymentStatus**](AppsV1Api.md#readNamespacedDeploymentStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | +[**readNamespacedReplicaSet**](AppsV1Api.md#readNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**readNamespacedReplicaSetScale**](AppsV1Api.md#readNamespacedReplicaSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | +[**readNamespacedReplicaSetStatus**](AppsV1Api.md#readNamespacedReplicaSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | +[**readNamespacedStatefulSet**](AppsV1Api.md#readNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**readNamespacedStatefulSetScale**](AppsV1Api.md#readNamespacedStatefulSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | +[**readNamespacedStatefulSetStatus**](AppsV1Api.md#readNamespacedStatefulSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | +[**replaceNamespacedControllerRevision**](AppsV1Api.md#replaceNamespacedControllerRevision) | **PUT** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**replaceNamespacedDaemonSet**](AppsV1Api.md#replaceNamespacedDaemonSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**replaceNamespacedDaemonSetStatus**](AppsV1Api.md#replaceNamespacedDaemonSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | +[**replaceNamespacedDeployment**](AppsV1Api.md#replaceNamespacedDeployment) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**replaceNamespacedDeploymentScale**](AppsV1Api.md#replaceNamespacedDeploymentScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | +[**replaceNamespacedDeploymentStatus**](AppsV1Api.md#replaceNamespacedDeploymentStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | +[**replaceNamespacedReplicaSet**](AppsV1Api.md#replaceNamespacedReplicaSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**replaceNamespacedReplicaSetScale**](AppsV1Api.md#replaceNamespacedReplicaSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | +[**replaceNamespacedReplicaSetStatus**](AppsV1Api.md#replaceNamespacedReplicaSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | +[**replaceNamespacedStatefulSet**](AppsV1Api.md#replaceNamespacedStatefulSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**replaceNamespacedStatefulSetScale**](AppsV1Api.md#replaceNamespacedStatefulSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | +[**replaceNamespacedStatefulSetStatus**](AppsV1Api.md#replaceNamespacedStatefulSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | + + +# **createNamespacedControllerRevision** +> V1ControllerRevision createNamespacedControllerRevision(body) + +create a ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiCreateNamespacedControllerRevisionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedControllerRevisionRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: {}, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + revision: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ControllerRevision**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ControllerRevision** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedDaemonSet** +> V1DaemonSet createNamespacedDaemonSet(body) + +create a DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiCreateNamespacedDaemonSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedDaemonSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + }, + status: { + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentNumberScheduled: 1, + desiredNumberScheduled: 1, + numberAvailable: 1, + numberMisscheduled: 1, + numberReady: 1, + numberUnavailable: 1, + observedGeneration: 1, + updatedNumberScheduled: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DaemonSet**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1DaemonSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedDeployment** +> V1Deployment createNamespacedDeployment(body) + +create a Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiCreateNamespacedDeploymentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedDeploymentRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + paused: true, + progressDeadlineSeconds: 1, + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + strategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + unavailableReplicas: 1, + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Deployment**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Deployment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedReplicaSet** +> V1ReplicaSet createNamespacedReplicaSet(body) + +create a ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiCreateNamespacedReplicaSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedReplicaSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicaSet**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ReplicaSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedStatefulSet** +> V1StatefulSet createNamespacedStatefulSet(body) + +create a StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiCreateNamespacedStatefulSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedStatefulSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + ordinals: { + start: 1, + }, + persistentVolumeClaimRetentionPolicy: { + whenDeleted: "whenDeleted_example", + whenScaled: "whenScaled_example", + }, + podManagementPolicy: "podManagementPolicy_example", + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + serviceName: "serviceName_example", + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxUnavailable: "maxUnavailable_example", + partition: 1, + }, + type: "type_example", + }, + volumeClaimTemplates: [ + { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + ], + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentReplicas: 1, + currentRevision: "currentRevision_example", + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + updateRevision: "updateRevision_example", + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StatefulSet**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1StatefulSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedControllerRevision** +> V1Status deleteCollectionNamespacedControllerRevision() + +delete collection of ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedDaemonSet** +> V1Status deleteCollectionNamespacedDaemonSet() + +delete collection of DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedDeployment** +> V1Status deleteCollectionNamespacedDeployment() + +delete collection of Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiDeleteCollectionNamespacedDeploymentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedDeploymentRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedReplicaSet** +> V1Status deleteCollectionNamespacedReplicaSet() + +delete collection of ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedStatefulSet** +> V1Status deleteCollectionNamespacedStatefulSet() + +delete collection of StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedControllerRevision** +> V1Status deleteNamespacedControllerRevision() + +delete a ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiDeleteNamespacedControllerRevisionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedDaemonSet** +> V1Status deleteNamespacedDaemonSet() + +delete a DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiDeleteNamespacedDaemonSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedDeployment** +> V1Status deleteNamespacedDeployment() + +delete a Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiDeleteNamespacedDeploymentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedReplicaSet** +> V1Status deleteNamespacedReplicaSet() + +delete a ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiDeleteNamespacedReplicaSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedStatefulSet** +> V1Status deleteNamespacedStatefulSet() + +delete a StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiDeleteNamespacedStatefulSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listControllerRevisionForAllNamespaces** +> V1ControllerRevisionList listControllerRevisionForAllNamespaces() + +list or watch objects of kind ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiListControllerRevisionForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListControllerRevisionForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listControllerRevisionForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ControllerRevisionList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listDaemonSetForAllNamespaces** +> V1DaemonSetList listDaemonSetForAllNamespaces() + +list or watch objects of kind DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiListDaemonSetForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListDaemonSetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDaemonSetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1DaemonSetList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listDeploymentForAllNamespaces** +> V1DeploymentList listDeploymentForAllNamespaces() + +list or watch objects of kind Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiListDeploymentForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListDeploymentForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeploymentForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1DeploymentList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedControllerRevision** +> V1ControllerRevisionList listNamespacedControllerRevision() + +list or watch objects of kind ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiListNamespacedControllerRevisionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedControllerRevisionRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ControllerRevisionList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedDaemonSet** +> V1DaemonSetList listNamespacedDaemonSet() + +list or watch objects of kind DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiListNamespacedDaemonSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedDaemonSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1DaemonSetList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedDeployment** +> V1DeploymentList listNamespacedDeployment() + +list or watch objects of kind Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiListNamespacedDeploymentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedDeploymentRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1DeploymentList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedReplicaSet** +> V1ReplicaSetList listNamespacedReplicaSet() + +list or watch objects of kind ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiListNamespacedReplicaSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedReplicaSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ReplicaSetList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedStatefulSet** +> V1StatefulSetList listNamespacedStatefulSet() + +list or watch objects of kind StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiListNamespacedStatefulSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedStatefulSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1StatefulSetList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listReplicaSetForAllNamespaces** +> V1ReplicaSetList listReplicaSetForAllNamespaces() + +list or watch objects of kind ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiListReplicaSetForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListReplicaSetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listReplicaSetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ReplicaSetList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listStatefulSetForAllNamespaces** +> V1StatefulSetList listStatefulSetForAllNamespaces() + +list or watch objects of kind StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiListStatefulSetForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListStatefulSetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStatefulSetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1StatefulSetList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedControllerRevision** +> V1ControllerRevision patchNamespacedControllerRevision(body) + +partially update the specified ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedControllerRevisionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ControllerRevision** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedDaemonSet** +> V1DaemonSet patchNamespacedDaemonSet(body) + +partially update the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedDaemonSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1DaemonSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedDaemonSetStatus** +> V1DaemonSet patchNamespacedDaemonSetStatus(body) + +partially update status of the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedDaemonSetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDaemonSetStatusRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDaemonSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1DaemonSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedDeployment** +> V1Deployment patchNamespacedDeployment(body) + +partially update the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedDeploymentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Deployment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedDeploymentScale** +> V1Scale patchNamespacedDeploymentScale(body) + +partially update scale of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedDeploymentScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDeploymentScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDeploymentScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedDeploymentStatus** +> V1Deployment patchNamespacedDeploymentStatus(body) + +partially update status of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedDeploymentStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDeploymentStatusRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDeploymentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Deployment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedReplicaSet** +> V1ReplicaSet patchNamespacedReplicaSet(body) + +partially update the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedReplicaSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ReplicaSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedReplicaSetScale** +> V1Scale patchNamespacedReplicaSetScale(body) + +partially update scale of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedReplicaSetScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedReplicaSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicaSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedReplicaSetStatus** +> V1ReplicaSet patchNamespacedReplicaSetStatus(body) + +partially update status of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedReplicaSetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedReplicaSetStatusRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicaSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ReplicaSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedStatefulSet** +> V1StatefulSet patchNamespacedStatefulSet(body) + +partially update the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedStatefulSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1StatefulSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedStatefulSetScale** +> V1Scale patchNamespacedStatefulSetScale(body) + +partially update scale of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedStatefulSetScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedStatefulSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedStatefulSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedStatefulSetStatus** +> V1StatefulSet patchNamespacedStatefulSetStatus(body) + +partially update status of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiPatchNamespacedStatefulSetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedStatefulSetStatusRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedStatefulSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1StatefulSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedControllerRevision** +> V1ControllerRevision readNamespacedControllerRevision() + +read the specified ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedControllerRevisionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ControllerRevision** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedDaemonSet** +> V1DaemonSet readNamespacedDaemonSet() + +read the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedDaemonSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1DaemonSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedDaemonSetStatus** +> V1DaemonSet readNamespacedDaemonSetStatus() + +read status of the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedDaemonSetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDaemonSetStatusRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDaemonSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1DaemonSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedDeployment** +> V1Deployment readNamespacedDeployment() + +read the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedDeploymentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Deployment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedDeploymentScale** +> V1Scale readNamespacedDeploymentScale() + +read scale of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedDeploymentScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDeploymentScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDeploymentScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedDeploymentStatus** +> V1Deployment readNamespacedDeploymentStatus() + +read status of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedDeploymentStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDeploymentStatusRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDeploymentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Deployment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedReplicaSet** +> V1ReplicaSet readNamespacedReplicaSet() + +read the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedReplicaSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ReplicaSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedReplicaSetScale** +> V1Scale readNamespacedReplicaSetScale() + +read scale of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedReplicaSetScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedReplicaSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicaSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedReplicaSetStatus** +> V1ReplicaSet readNamespacedReplicaSetStatus() + +read status of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedReplicaSetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedReplicaSetStatusRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicaSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ReplicaSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedStatefulSet** +> V1StatefulSet readNamespacedStatefulSet() + +read the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedStatefulSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1StatefulSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedStatefulSetScale** +> V1Scale readNamespacedStatefulSetScale() + +read scale of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedStatefulSetScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedStatefulSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedStatefulSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedStatefulSetStatus** +> V1StatefulSet readNamespacedStatefulSetStatus() + +read status of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReadNamespacedStatefulSetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedStatefulSetStatusRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedStatefulSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1StatefulSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedControllerRevision** +> V1ControllerRevision replaceNamespacedControllerRevision(body) + +replace the specified ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedControllerRevisionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: {}, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + revision: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ControllerRevision**| | + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ControllerRevision** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedDaemonSet** +> V1DaemonSet replaceNamespacedDaemonSet(body) + +replace the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedDaemonSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + }, + status: { + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentNumberScheduled: 1, + desiredNumberScheduled: 1, + numberAvailable: 1, + numberMisscheduled: 1, + numberReady: 1, + numberUnavailable: 1, + observedGeneration: 1, + updatedNumberScheduled: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DaemonSet**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1DaemonSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedDaemonSetStatus** +> V1DaemonSet replaceNamespacedDaemonSetStatus(body) + +replace status of the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedDaemonSetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDaemonSetStatusRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + }, + status: { + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentNumberScheduled: 1, + desiredNumberScheduled: 1, + numberAvailable: 1, + numberMisscheduled: 1, + numberReady: 1, + numberUnavailable: 1, + observedGeneration: 1, + updatedNumberScheduled: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDaemonSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DaemonSet**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1DaemonSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedDeployment** +> V1Deployment replaceNamespacedDeployment(body) + +replace the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedDeploymentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + paused: true, + progressDeadlineSeconds: 1, + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + strategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + unavailableReplicas: 1, + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Deployment**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Deployment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedDeploymentScale** +> V1Scale replaceNamespacedDeploymentScale(body) + +replace scale of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedDeploymentScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDeploymentScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDeploymentScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedDeploymentStatus** +> V1Deployment replaceNamespacedDeploymentStatus(body) + +replace status of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedDeploymentStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDeploymentStatusRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + paused: true, + progressDeadlineSeconds: 1, + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + strategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + unavailableReplicas: 1, + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDeploymentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Deployment**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Deployment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedReplicaSet** +> V1ReplicaSet replaceNamespacedReplicaSet(body) + +replace the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedReplicaSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicaSet**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ReplicaSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedReplicaSetScale** +> V1Scale replaceNamespacedReplicaSetScale(body) + +replace scale of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedReplicaSetScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedReplicaSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicaSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedReplicaSetStatus** +> V1ReplicaSet replaceNamespacedReplicaSetStatus(body) + +replace status of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedReplicaSetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedReplicaSetStatusRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicaSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicaSet**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ReplicaSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedStatefulSet** +> V1StatefulSet replaceNamespacedStatefulSet(body) + +replace the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedStatefulSetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + ordinals: { + start: 1, + }, + persistentVolumeClaimRetentionPolicy: { + whenDeleted: "whenDeleted_example", + whenScaled: "whenScaled_example", + }, + podManagementPolicy: "podManagementPolicy_example", + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + serviceName: "serviceName_example", + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxUnavailable: "maxUnavailable_example", + partition: 1, + }, + type: "type_example", + }, + volumeClaimTemplates: [ + { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + ], + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentReplicas: 1, + currentRevision: "currentRevision_example", + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + updateRevision: "updateRevision_example", + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StatefulSet**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1StatefulSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedStatefulSetScale** +> V1Scale replaceNamespacedStatefulSetScale(body) + +replace scale of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedStatefulSetScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedStatefulSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedStatefulSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedStatefulSetStatus** +> V1StatefulSet replaceNamespacedStatefulSetStatus(body) + +replace status of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from ''; +import type { AppsV1ApiReplaceNamespacedStatefulSetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedStatefulSetStatusRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + ordinals: { + start: 1, + }, + persistentVolumeClaimRetentionPolicy: { + whenDeleted: "whenDeleted_example", + whenScaled: "whenScaled_example", + }, + podManagementPolicy: "podManagementPolicy_example", + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + serviceName: "serviceName_example", + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxUnavailable: "maxUnavailable_example", + partition: 1, + }, + type: "type_example", + }, + volumeClaimTemplates: [ + { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + ], + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentReplicas: 1, + currentRevision: "currentRevision_example", + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + updateRevision: "updateRevision_example", + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedStatefulSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StatefulSet**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1StatefulSet** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AuthenticationApi.md b/src/gen/docs/AuthenticationApi.md new file mode 100644 index 0000000000..b141ecbe36 --- /dev/null +++ b/src/gen/docs/AuthenticationApi.md @@ -0,0 +1,57 @@ +# .AuthenticationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](AuthenticationApi.md#getAPIGroup) | **GET** /apis/authentication.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AuthenticationApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AuthenticationV1Api.md b/src/gen/docs/AuthenticationV1Api.md new file mode 100644 index 0000000000..426eecb015 --- /dev/null +++ b/src/gen/docs/AuthenticationV1Api.md @@ -0,0 +1,324 @@ +# .AuthenticationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createSelfSubjectReview**](AuthenticationV1Api.md#createSelfSubjectReview) | **POST** /apis/authentication.k8s.io/v1/selfsubjectreviews | +[**createTokenReview**](AuthenticationV1Api.md#createTokenReview) | **POST** /apis/authentication.k8s.io/v1/tokenreviews | +[**getAPIResources**](AuthenticationV1Api.md#getAPIResources) | **GET** /apis/authentication.k8s.io/v1/ | + + +# **createSelfSubjectReview** +> V1SelfSubjectReview createSelfSubjectReview(body) + +create a SelfSubjectReview + +### Example + + +```typescript +import { createConfiguration, AuthenticationV1Api } from ''; +import type { AuthenticationV1ApiCreateSelfSubjectReviewRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationV1Api(configuration); + +const request: AuthenticationV1ApiCreateSelfSubjectReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + status: { + userInfo: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + uid: "uid_example", + username: "username_example", + }, + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSelfSubjectReview(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SelfSubjectReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1SelfSubjectReview** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createTokenReview** +> V1TokenReview createTokenReview(body) + +create a TokenReview + +### Example + + +```typescript +import { createConfiguration, AuthenticationV1Api } from ''; +import type { AuthenticationV1ApiCreateTokenReviewRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationV1Api(configuration); + +const request: AuthenticationV1ApiCreateTokenReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + audiences: [ + "audiences_example", + ], + token: "token_example", + }, + status: { + audiences: [ + "audiences_example", + ], + authenticated: true, + error: "error_example", + user: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + uid: "uid_example", + username: "username_example", + }, + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createTokenReview(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1TokenReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1TokenReview** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AuthenticationV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AuthorizationApi.md b/src/gen/docs/AuthorizationApi.md new file mode 100644 index 0000000000..69c1a79f0f --- /dev/null +++ b/src/gen/docs/AuthorizationApi.md @@ -0,0 +1,57 @@ +# .AuthorizationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](AuthorizationApi.md#getAPIGroup) | **GET** /apis/authorization.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AuthorizationApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AuthorizationV1Api.md b/src/gen/docs/AuthorizationV1Api.md new file mode 100644 index 0000000000..3cda3dc62f --- /dev/null +++ b/src/gen/docs/AuthorizationV1Api.md @@ -0,0 +1,704 @@ +# .AuthorizationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLocalSubjectAccessReview**](AuthorizationV1Api.md#createNamespacedLocalSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews | +[**createSelfSubjectAccessReview**](AuthorizationV1Api.md#createSelfSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectaccessreviews | +[**createSelfSubjectRulesReview**](AuthorizationV1Api.md#createSelfSubjectRulesReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectrulesreviews | +[**createSubjectAccessReview**](AuthorizationV1Api.md#createSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/subjectaccessreviews | +[**getAPIResources**](AuthorizationV1Api.md#getAPIResources) | **GET** /apis/authorization.k8s.io/v1/ | + + +# **createNamespacedLocalSubjectAccessReview** +> V1LocalSubjectAccessReview createNamespacedLocalSubjectAccessReview(body) + +create a LocalSubjectAccessReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from ''; +import type { AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + nonResourceAttributes: { + path: "path_example", + verb: "verb_example", + }, + resourceAttributes: { + fieldSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + group: "group_example", + labelSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + subresource: "subresource_example", + verb: "verb_example", + version: "version_example", + }, + uid: "uid_example", + user: "user_example", + }, + status: { + allowed: true, + denied: true, + evaluationError: "evaluationError_example", + reason: "reason_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedLocalSubjectAccessReview(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1LocalSubjectAccessReview**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1LocalSubjectAccessReview** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createSelfSubjectAccessReview** +> V1SelfSubjectAccessReview createSelfSubjectAccessReview(body) + +create a SelfSubjectAccessReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from ''; +import type { AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + nonResourceAttributes: { + path: "path_example", + verb: "verb_example", + }, + resourceAttributes: { + fieldSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + group: "group_example", + labelSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + subresource: "subresource_example", + verb: "verb_example", + version: "version_example", + }, + }, + status: { + allowed: true, + denied: true, + evaluationError: "evaluationError_example", + reason: "reason_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSelfSubjectAccessReview(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SelfSubjectAccessReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1SelfSubjectAccessReview** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createSelfSubjectRulesReview** +> V1SelfSubjectRulesReview createSelfSubjectRulesReview(body) + +create a SelfSubjectRulesReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from ''; +import type { AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + namespace: "namespace_example", + }, + status: { + evaluationError: "evaluationError_example", + incomplete: true, + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSelfSubjectRulesReview(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SelfSubjectRulesReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1SelfSubjectRulesReview** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createSubjectAccessReview** +> V1SubjectAccessReview createSubjectAccessReview(body) + +create a SubjectAccessReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from ''; +import type { AuthorizationV1ApiCreateSubjectAccessReviewRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateSubjectAccessReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + nonResourceAttributes: { + path: "path_example", + verb: "verb_example", + }, + resourceAttributes: { + fieldSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + group: "group_example", + labelSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + subresource: "subresource_example", + verb: "verb_example", + version: "version_example", + }, + uid: "uid_example", + user: "user_example", + }, + status: { + allowed: true, + denied: true, + evaluationError: "evaluationError_example", + reason: "reason_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSubjectAccessReview(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SubjectAccessReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1SubjectAccessReview** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AutoscalingApi.md b/src/gen/docs/AutoscalingApi.md new file mode 100644 index 0000000000..c116b93e84 --- /dev/null +++ b/src/gen/docs/AutoscalingApi.md @@ -0,0 +1,57 @@ +# .AutoscalingApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](AutoscalingApi.md#getAPIGroup) | **GET** /apis/autoscaling/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AutoscalingApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AutoscalingV1Api.md b/src/gen/docs/AutoscalingV1Api.md new file mode 100644 index 0000000000..77c199e966 --- /dev/null +++ b/src/gen/docs/AutoscalingV1Api.md @@ -0,0 +1,1120 @@ +# .AutoscalingV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteCollectionNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**getAPIResources**](AutoscalingV1Api.md#getAPIResources) | **GET** /apis/autoscaling/v1/ | +[**listHorizontalPodAutoscalerForAllNamespaces**](AutoscalingV1Api.md#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v1/horizontalpodautoscalers | +[**listNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | +[**patchNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**patchNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV1Api.md#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**readNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**readNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV1Api.md#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**replaceNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**replaceNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV1Api.md#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | + + +# **createNamespacedHorizontalPodAutoscaler** +> V1HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) + +create a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxReplicas: 1, + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + targetCPUUtilizationPercentage: 1, + }, + status: { + currentCPUUtilizationPercentage: 1, + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1HorizontalPodAutoscaler**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedHorizontalPodAutoscaler** +> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() + +delete collection of HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedHorizontalPodAutoscaler** +> V1Status deleteNamespacedHorizontalPodAutoscaler() + +delete a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listHorizontalPodAutoscalerForAllNamespaces** +> V1HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1HorizontalPodAutoscalerList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedHorizontalPodAutoscaler** +> V1HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1HorizontalPodAutoscalerList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedHorizontalPodAutoscaler** +> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) + +partially update the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedHorizontalPodAutoscalerStatus** +> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) + +partially update status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedHorizontalPodAutoscaler** +> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() + +read the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedHorizontalPodAutoscalerStatus** +> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() + +read status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedHorizontalPodAutoscaler** +> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) + +replace the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxReplicas: 1, + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + targetCPUUtilizationPercentage: 1, + }, + status: { + currentCPUUtilizationPercentage: 1, + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedHorizontalPodAutoscalerStatus** +> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) + +replace status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from ''; +import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxReplicas: 1, + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + targetCPUUtilizationPercentage: 1, + }, + status: { + currentCPUUtilizationPercentage: 1, + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/AutoscalingV2Api.md b/src/gen/docs/AutoscalingV2Api.md new file mode 100644 index 0000000000..c7c2c1e6cf --- /dev/null +++ b/src/gen/docs/AutoscalingV2Api.md @@ -0,0 +1,1828 @@ +# .AutoscalingV2Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteCollectionNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**getAPIResources**](AutoscalingV2Api.md#getAPIResources) | **GET** /apis/autoscaling/v2/ | +[**listHorizontalPodAutoscalerForAllNamespaces**](AutoscalingV2Api.md#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v2/horizontalpodautoscalers | +[**listNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | +[**patchNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**patchNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV2Api.md#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**readNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**readNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV2Api.md#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**replaceNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**replaceNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV2Api.md#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | + + +# **createNamespacedHorizontalPodAutoscaler** +> V2HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) + +create a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + behavior: { + scaleDown: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + scaleUp: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + }, + maxReplicas: 1, + metrics: [ + { + containerResource: { + container: "container_example", + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + external: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + object: { + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + pods: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + resource: { + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + type: "type_example", + }, + ], + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentMetrics: [ + { + containerResource: { + container: "container_example", + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + external: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + object: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + pods: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + resource: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + type: "type_example", + }, + ], + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V2HorizontalPodAutoscaler**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V2HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedHorizontalPodAutoscaler** +> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() + +delete collection of HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedHorizontalPodAutoscaler** +> V1Status deleteNamespacedHorizontalPodAutoscaler() + +delete a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listHorizontalPodAutoscalerForAllNamespaces** +> V2HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V2HorizontalPodAutoscalerList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedHorizontalPodAutoscaler** +> V2HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V2HorizontalPodAutoscalerList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedHorizontalPodAutoscaler** +> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) + +partially update the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V2HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedHorizontalPodAutoscalerStatus** +> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) + +partially update status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V2HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedHorizontalPodAutoscaler** +> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() + +read the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V2HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedHorizontalPodAutoscalerStatus** +> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() + +read status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V2HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedHorizontalPodAutoscaler** +> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) + +replace the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + behavior: { + scaleDown: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + scaleUp: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + }, + maxReplicas: 1, + metrics: [ + { + containerResource: { + container: "container_example", + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + external: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + object: { + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + pods: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + resource: { + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + type: "type_example", + }, + ], + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentMetrics: [ + { + containerResource: { + container: "container_example", + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + external: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + object: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + pods: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + resource: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + type: "type_example", + }, + ], + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V2HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V2HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedHorizontalPodAutoscalerStatus** +> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) + +replace status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from ''; +import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + behavior: { + scaleDown: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + scaleUp: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + }, + maxReplicas: 1, + metrics: [ + { + containerResource: { + container: "container_example", + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + external: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + object: { + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + pods: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + resource: { + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + type: "type_example", + }, + ], + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentMetrics: [ + { + containerResource: { + container: "container_example", + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + external: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + object: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + pods: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + resource: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + type: "type_example", + }, + ], + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V2HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V2HorizontalPodAutoscaler** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/BatchApi.md b/src/gen/docs/BatchApi.md new file mode 100644 index 0000000000..12d7a4b468 --- /dev/null +++ b/src/gen/docs/BatchApi.md @@ -0,0 +1,57 @@ +# .BatchApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](BatchApi.md#getAPIGroup) | **GET** /apis/batch/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, BatchApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/BatchV1Api.md b/src/gen/docs/BatchV1Api.md new file mode 100644 index 0000000000..901c763f22 --- /dev/null +++ b/src/gen/docs/BatchV1Api.md @@ -0,0 +1,13484 @@ +# .BatchV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedCronJob**](BatchV1Api.md#createNamespacedCronJob) | **POST** /apis/batch/v1/namespaces/{namespace}/cronjobs | +[**createNamespacedJob**](BatchV1Api.md#createNamespacedJob) | **POST** /apis/batch/v1/namespaces/{namespace}/jobs | +[**deleteCollectionNamespacedCronJob**](BatchV1Api.md#deleteCollectionNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs | +[**deleteCollectionNamespacedJob**](BatchV1Api.md#deleteCollectionNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs | +[**deleteNamespacedCronJob**](BatchV1Api.md#deleteNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**deleteNamespacedJob**](BatchV1Api.md#deleteNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**getAPIResources**](BatchV1Api.md#getAPIResources) | **GET** /apis/batch/v1/ | +[**listCronJobForAllNamespaces**](BatchV1Api.md#listCronJobForAllNamespaces) | **GET** /apis/batch/v1/cronjobs | +[**listJobForAllNamespaces**](BatchV1Api.md#listJobForAllNamespaces) | **GET** /apis/batch/v1/jobs | +[**listNamespacedCronJob**](BatchV1Api.md#listNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs | +[**listNamespacedJob**](BatchV1Api.md#listNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs | +[**patchNamespacedCronJob**](BatchV1Api.md#patchNamespacedCronJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**patchNamespacedCronJobStatus**](BatchV1Api.md#patchNamespacedCronJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | +[**patchNamespacedJob**](BatchV1Api.md#patchNamespacedJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**patchNamespacedJobStatus**](BatchV1Api.md#patchNamespacedJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | +[**readNamespacedCronJob**](BatchV1Api.md#readNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**readNamespacedCronJobStatus**](BatchV1Api.md#readNamespacedCronJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | +[**readNamespacedJob**](BatchV1Api.md#readNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**readNamespacedJobStatus**](BatchV1Api.md#readNamespacedJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | +[**replaceNamespacedCronJob**](BatchV1Api.md#replaceNamespacedCronJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**replaceNamespacedCronJobStatus**](BatchV1Api.md#replaceNamespacedCronJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | +[**replaceNamespacedJob**](BatchV1Api.md#replaceNamespacedJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**replaceNamespacedJobStatus**](BatchV1Api.md#replaceNamespacedJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | + + +# **createNamespacedCronJob** +> V1CronJob createNamespacedCronJob(body) + +create a CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiCreateNamespacedCronJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiCreateNamespacedCronJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + concurrencyPolicy: "concurrencyPolicy_example", + failedJobsHistoryLimit: 1, + jobTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + }, + schedule: "schedule_example", + startingDeadlineSeconds: 1, + successfulJobsHistoryLimit: 1, + suspend: true, + timeZone: "timeZone_example", + }, + status: { + active: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), + lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CronJob**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CronJob** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedJob** +> V1Job createNamespacedJob(body) + +create a Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiCreateNamespacedJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiCreateNamespacedJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + status: { + active: 1, + completedIndexes: "completedIndexes_example", + completionTime: new Date('1970-01-01T00:00:00.00Z'), + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + failed: 1, + failedIndexes: "failedIndexes_example", + ready: 1, + startTime: new Date('1970-01-01T00:00:00.00Z'), + succeeded: 1, + terminating: 1, + uncountedTerminatedPods: { + failed: [ + "failed_example", + ], + succeeded: [ + "succeeded_example", + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Job**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Job** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedCronJob** +> V1Status deleteCollectionNamespacedCronJob() + +delete collection of CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiDeleteCollectionNamespacedCronJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteCollectionNamespacedCronJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedJob** +> V1Status deleteCollectionNamespacedJob() + +delete collection of Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiDeleteCollectionNamespacedJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteCollectionNamespacedJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedCronJob** +> V1Status deleteNamespacedCronJob() + +delete a CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiDeleteNamespacedCronJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedJob** +> V1Status deleteNamespacedJob() + +delete a Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiDeleteNamespacedJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listCronJobForAllNamespaces** +> V1CronJobList listCronJobForAllNamespaces() + +list or watch objects of kind CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiListCronJobForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListCronJobForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCronJobForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1CronJobList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listJobForAllNamespaces** +> V1JobList listJobForAllNamespaces() + +list or watch objects of kind Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiListJobForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListJobForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listJobForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1JobList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedCronJob** +> V1CronJobList listNamespacedCronJob() + +list or watch objects of kind CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiListNamespacedCronJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListNamespacedCronJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1CronJobList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedJob** +> V1JobList listNamespacedJob() + +list or watch objects of kind Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiListNamespacedJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListNamespacedJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1JobList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedCronJob** +> V1CronJob patchNamespacedCronJob(body) + +partially update the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiPatchNamespacedCronJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1CronJob** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedCronJobStatus** +> V1CronJob patchNamespacedCronJobStatus(body) + +partially update status of the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiPatchNamespacedCronJobStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedCronJobStatusRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCronJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1CronJob** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedJob** +> V1Job patchNamespacedJob(body) + +partially update the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiPatchNamespacedJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Job** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedJobStatus** +> V1Job patchNamespacedJobStatus(body) + +partially update status of the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiPatchNamespacedJobStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedJobStatusRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Job** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedCronJob** +> V1CronJob readNamespacedCronJob() + +read the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiReadNamespacedCronJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1CronJob** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedCronJobStatus** +> V1CronJob readNamespacedCronJobStatus() + +read status of the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiReadNamespacedCronJobStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedCronJobStatusRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedCronJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1CronJob** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedJob** +> V1Job readNamespacedJob() + +read the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiReadNamespacedJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Job** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedJobStatus** +> V1Job readNamespacedJobStatus() + +read status of the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiReadNamespacedJobStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedJobStatusRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Job** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedCronJob** +> V1CronJob replaceNamespacedCronJob(body) + +replace the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiReplaceNamespacedCronJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + concurrencyPolicy: "concurrencyPolicy_example", + failedJobsHistoryLimit: 1, + jobTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + }, + schedule: "schedule_example", + startingDeadlineSeconds: 1, + successfulJobsHistoryLimit: 1, + suspend: true, + timeZone: "timeZone_example", + }, + status: { + active: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), + lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CronJob**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CronJob** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedCronJobStatus** +> V1CronJob replaceNamespacedCronJobStatus(body) + +replace status of the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiReplaceNamespacedCronJobStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedCronJobStatusRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + concurrencyPolicy: "concurrencyPolicy_example", + failedJobsHistoryLimit: 1, + jobTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + }, + schedule: "schedule_example", + startingDeadlineSeconds: 1, + successfulJobsHistoryLimit: 1, + suspend: true, + timeZone: "timeZone_example", + }, + status: { + active: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), + lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCronJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CronJob**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CronJob** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedJob** +> V1Job replaceNamespacedJob(body) + +replace the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiReplaceNamespacedJobRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + status: { + active: 1, + completedIndexes: "completedIndexes_example", + completionTime: new Date('1970-01-01T00:00:00.00Z'), + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + failed: 1, + failedIndexes: "failedIndexes_example", + ready: 1, + startTime: new Date('1970-01-01T00:00:00.00Z'), + succeeded: 1, + terminating: 1, + uncountedTerminatedPods: { + failed: [ + "failed_example", + ], + succeeded: [ + "succeeded_example", + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Job**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Job** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedJobStatus** +> V1Job replaceNamespacedJobStatus(body) + +replace status of the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from ''; +import type { BatchV1ApiReplaceNamespacedJobStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedJobStatusRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + status: { + active: 1, + completedIndexes: "completedIndexes_example", + completionTime: new Date('1970-01-01T00:00:00.00Z'), + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + failed: 1, + failedIndexes: "failedIndexes_example", + ready: 1, + startTime: new Date('1970-01-01T00:00:00.00Z'), + succeeded: 1, + terminating: 1, + uncountedTerminatedPods: { + failed: [ + "failed_example", + ], + succeeded: [ + "succeeded_example", + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Job**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Job** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CertificatesApi.md b/src/gen/docs/CertificatesApi.md new file mode 100644 index 0000000000..72f718b2c4 --- /dev/null +++ b/src/gen/docs/CertificatesApi.md @@ -0,0 +1,57 @@ +# .CertificatesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](CertificatesApi.md#getAPIGroup) | **GET** /apis/certificates.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, CertificatesApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CertificatesV1Api.md b/src/gen/docs/CertificatesV1Api.md new file mode 100644 index 0000000000..04d6d18f12 --- /dev/null +++ b/src/gen/docs/CertificatesV1Api.md @@ -0,0 +1,1326 @@ +# .CertificatesV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createCertificateSigningRequest**](CertificatesV1Api.md#createCertificateSigningRequest) | **POST** /apis/certificates.k8s.io/v1/certificatesigningrequests | +[**deleteCertificateSigningRequest**](CertificatesV1Api.md#deleteCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**deleteCollectionCertificateSigningRequest**](CertificatesV1Api.md#deleteCollectionCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests | +[**getAPIResources**](CertificatesV1Api.md#getAPIResources) | **GET** /apis/certificates.k8s.io/v1/ | +[**listCertificateSigningRequest**](CertificatesV1Api.md#listCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests | +[**patchCertificateSigningRequest**](CertificatesV1Api.md#patchCertificateSigningRequest) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**patchCertificateSigningRequestApproval**](CertificatesV1Api.md#patchCertificateSigningRequestApproval) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | +[**patchCertificateSigningRequestStatus**](CertificatesV1Api.md#patchCertificateSigningRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | +[**readCertificateSigningRequest**](CertificatesV1Api.md#readCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**readCertificateSigningRequestApproval**](CertificatesV1Api.md#readCertificateSigningRequestApproval) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | +[**readCertificateSigningRequestStatus**](CertificatesV1Api.md#readCertificateSigningRequestStatus) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | +[**replaceCertificateSigningRequest**](CertificatesV1Api.md#replaceCertificateSigningRequest) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**replaceCertificateSigningRequestApproval**](CertificatesV1Api.md#replaceCertificateSigningRequestApproval) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | +[**replaceCertificateSigningRequestStatus**](CertificatesV1Api.md#replaceCertificateSigningRequestStatus) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | + + +# **createCertificateSigningRequest** +> V1CertificateSigningRequest createCertificateSigningRequest(body) + +create a CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiCreateCertificateSigningRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiCreateCertificateSigningRequestRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCertificateSigningRequest** +> V1Status deleteCertificateSigningRequest() + +delete a CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiDeleteCertificateSigningRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiDeleteCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionCertificateSigningRequest** +> V1Status deleteCollectionCertificateSigningRequest() + +delete collection of CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listCertificateSigningRequest** +> V1CertificateSigningRequestList listCertificateSigningRequest() + +list or watch objects of kind CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiListCertificateSigningRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiListCertificateSigningRequestRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequestList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchCertificateSigningRequest** +> V1CertificateSigningRequest patchCertificateSigningRequest(body) + +partially update the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiPatchCertificateSigningRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiPatchCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchCertificateSigningRequestApproval** +> V1CertificateSigningRequest patchCertificateSigningRequestApproval(body) + +partially update approval of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCertificateSigningRequestApproval(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchCertificateSigningRequestStatus** +> V1CertificateSigningRequest patchCertificateSigningRequestStatus(body) + +partially update status of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiPatchCertificateSigningRequestStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiPatchCertificateSigningRequestStatusRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCertificateSigningRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readCertificateSigningRequest** +> V1CertificateSigningRequest readCertificateSigningRequest() + +read the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiReadCertificateSigningRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReadCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readCertificateSigningRequestApproval** +> V1CertificateSigningRequest readCertificateSigningRequestApproval() + +read approval of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiReadCertificateSigningRequestApprovalRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReadCertificateSigningRequestApprovalRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCertificateSigningRequestApproval(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readCertificateSigningRequestStatus** +> V1CertificateSigningRequest readCertificateSigningRequestStatus() + +read status of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiReadCertificateSigningRequestStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReadCertificateSigningRequestStatusRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCertificateSigningRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceCertificateSigningRequest** +> V1CertificateSigningRequest replaceCertificateSigningRequest(body) + +replace the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiReplaceCertificateSigningRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReplaceCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceCertificateSigningRequestApproval** +> V1CertificateSigningRequest replaceCertificateSigningRequestApproval(body) + +replace approval of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCertificateSigningRequestApproval(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceCertificateSigningRequestStatus** +> V1CertificateSigningRequest replaceCertificateSigningRequestStatus(body) + +replace status of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from ''; +import type { CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCertificateSigningRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CertificateSigningRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CertificatesV1alpha1Api.md b/src/gen/docs/CertificatesV1alpha1Api.md new file mode 100644 index 0000000000..359cf306c8 --- /dev/null +++ b/src/gen/docs/CertificatesV1alpha1Api.md @@ -0,0 +1,714 @@ +# .CertificatesV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterTrustBundle**](CertificatesV1alpha1Api.md#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | +[**deleteClusterTrustBundle**](CertificatesV1alpha1Api.md#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | +[**deleteCollectionClusterTrustBundle**](CertificatesV1alpha1Api.md#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | +[**getAPIResources**](CertificatesV1alpha1Api.md#getAPIResources) | **GET** /apis/certificates.k8s.io/v1alpha1/ | +[**listClusterTrustBundle**](CertificatesV1alpha1Api.md#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | +[**patchClusterTrustBundle**](CertificatesV1alpha1Api.md#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | +[**readClusterTrustBundle**](CertificatesV1alpha1Api.md#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | +[**replaceClusterTrustBundle**](CertificatesV1alpha1Api.md#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | + + +# **createClusterTrustBundle** +> V1alpha1ClusterTrustBundle createClusterTrustBundle(body) + +create a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from ''; +import type { CertificatesV1alpha1ApiCreateClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiCreateClusterTrustBundleRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1ClusterTrustBundle**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1ClusterTrustBundle** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteClusterTrustBundle** +> V1Status deleteClusterTrustBundle() + +delete a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from ''; +import type { CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionClusterTrustBundle** +> V1Status deleteCollectionClusterTrustBundle() + +delete collection of ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from ''; +import type { CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listClusterTrustBundle** +> V1alpha1ClusterTrustBundleList listClusterTrustBundle() + +list or watch objects of kind ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from ''; +import type { CertificatesV1alpha1ApiListClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiListClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1alpha1ClusterTrustBundleList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchClusterTrustBundle** +> V1alpha1ClusterTrustBundle patchClusterTrustBundle(body) + +partially update the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from ''; +import type { CertificatesV1alpha1ApiPatchClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiPatchClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1alpha1ClusterTrustBundle** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readClusterTrustBundle** +> V1alpha1ClusterTrustBundle readClusterTrustBundle() + +read the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from ''; +import type { CertificatesV1alpha1ApiReadClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiReadClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1alpha1ClusterTrustBundle** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceClusterTrustBundle** +> V1alpha1ClusterTrustBundle replaceClusterTrustBundle(body) + +replace the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from ''; +import type { CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1ClusterTrustBundle**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1ClusterTrustBundle** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CertificatesV1beta1Api.md b/src/gen/docs/CertificatesV1beta1Api.md new file mode 100644 index 0000000000..c3441c934c --- /dev/null +++ b/src/gen/docs/CertificatesV1beta1Api.md @@ -0,0 +1,1819 @@ +# .CertificatesV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterTrustBundle**](CertificatesV1beta1Api.md#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | +[**createNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#createNamespacedPodCertificateRequest) | **POST** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | +[**deleteClusterTrustBundle**](CertificatesV1beta1Api.md#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**deleteCollectionClusterTrustBundle**](CertificatesV1beta1Api.md#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | +[**deleteCollectionNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#deleteCollectionNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | +[**deleteNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#deleteNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**getAPIResources**](CertificatesV1beta1Api.md#getAPIResources) | **GET** /apis/certificates.k8s.io/v1beta1/ | +[**listClusterTrustBundle**](CertificatesV1beta1Api.md#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | +[**listNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#listNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | +[**listPodCertificateRequestForAllNamespaces**](CertificatesV1beta1Api.md#listPodCertificateRequestForAllNamespaces) | **GET** /apis/certificates.k8s.io/v1beta1/podcertificaterequests | +[**patchClusterTrustBundle**](CertificatesV1beta1Api.md#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**patchNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#patchNamespacedPodCertificateRequest) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**patchNamespacedPodCertificateRequestStatus**](CertificatesV1beta1Api.md#patchNamespacedPodCertificateRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | +[**readClusterTrustBundle**](CertificatesV1beta1Api.md#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**readNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#readNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**readNamespacedPodCertificateRequestStatus**](CertificatesV1beta1Api.md#readNamespacedPodCertificateRequestStatus) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | +[**replaceClusterTrustBundle**](CertificatesV1beta1Api.md#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**replaceNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#replaceNamespacedPodCertificateRequest) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**replaceNamespacedPodCertificateRequestStatus**](CertificatesV1beta1Api.md#replaceNamespacedPodCertificateRequestStatus) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | + + +# **createClusterTrustBundle** +> V1beta1ClusterTrustBundle createClusterTrustBundle(body) + +create a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiCreateClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiCreateClusterTrustBundleRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ClusterTrustBundle**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ClusterTrustBundle** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedPodCertificateRequest** +> V1beta1PodCertificateRequest createNamespacedPodCertificateRequest(body) + +create a PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxExpirationSeconds: 1, + nodeName: "nodeName_example", + nodeUID: "nodeUID_example", + pkixPublicKey: 'YQ==', + podName: "podName_example", + podUID: "podUID_example", + proofOfPossession: 'YQ==', + serviceAccountName: "serviceAccountName_example", + serviceAccountUID: "serviceAccountUID_example", + signerName: "signerName_example", + unverifiedUserAnnotations: { + "key": "key_example", + }, + }, + status: { + beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), + certificateChain: "certificateChain_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + notAfter: new Date('1970-01-01T00:00:00.00Z'), + notBefore: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1PodCertificateRequest**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1PodCertificateRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteClusterTrustBundle** +> V1Status deleteClusterTrustBundle() + +delete a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiDeleteClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionClusterTrustBundle** +> V1Status deleteCollectionClusterTrustBundle() + +delete collection of ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedPodCertificateRequest** +> V1Status deleteCollectionNamespacedPodCertificateRequest() + +delete collection of PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedPodCertificateRequest** +> V1Status deleteNamespacedPodCertificateRequest() + +delete a PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listClusterTrustBundle** +> V1beta1ClusterTrustBundleList listClusterTrustBundle() + +list or watch objects of kind ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiListClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiListClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1ClusterTrustBundleList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedPodCertificateRequest** +> V1beta1PodCertificateRequestList listNamespacedPodCertificateRequest() + +list or watch objects of kind PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1PodCertificateRequestList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listPodCertificateRequestForAllNamespaces** +> V1beta1PodCertificateRequestList listPodCertificateRequestForAllNamespaces() + +list or watch objects of kind PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodCertificateRequestForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1PodCertificateRequestList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchClusterTrustBundle** +> V1beta1ClusterTrustBundle patchClusterTrustBundle(body) + +partially update the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiPatchClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiPatchClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1ClusterTrustBundle** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPodCertificateRequest** +> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequest(body) + +partially update the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1PodCertificateRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPodCertificateRequestStatus** +> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequestStatus(body) + +partially update status of the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodCertificateRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1PodCertificateRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readClusterTrustBundle** +> V1beta1ClusterTrustBundle readClusterTrustBundle() + +read the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiReadClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReadClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1ClusterTrustBundle** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPodCertificateRequest** +> V1beta1PodCertificateRequest readNamespacedPodCertificateRequest() + +read the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1PodCertificateRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPodCertificateRequestStatus** +> V1beta1PodCertificateRequest readNamespacedPodCertificateRequestStatus() + +read status of the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodCertificateRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1PodCertificateRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceClusterTrustBundle** +> V1beta1ClusterTrustBundle replaceClusterTrustBundle(body) + +replace the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiReplaceClusterTrustBundleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReplaceClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ClusterTrustBundle**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ClusterTrustBundle** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPodCertificateRequest** +> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequest(body) + +replace the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxExpirationSeconds: 1, + nodeName: "nodeName_example", + nodeUID: "nodeUID_example", + pkixPublicKey: 'YQ==', + podName: "podName_example", + podUID: "podUID_example", + proofOfPossession: 'YQ==', + serviceAccountName: "serviceAccountName_example", + serviceAccountUID: "serviceAccountUID_example", + signerName: "signerName_example", + unverifiedUserAnnotations: { + "key": "key_example", + }, + }, + status: { + beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), + certificateChain: "certificateChain_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + notAfter: new Date('1970-01-01T00:00:00.00Z'), + notBefore: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1PodCertificateRequest**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1PodCertificateRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPodCertificateRequestStatus** +> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequestStatus(body) + +replace status of the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from ''; +import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxExpirationSeconds: 1, + nodeName: "nodeName_example", + nodeUID: "nodeUID_example", + pkixPublicKey: 'YQ==', + podName: "podName_example", + podUID: "podUID_example", + proofOfPossession: 'YQ==', + serviceAccountName: "serviceAccountName_example", + serviceAccountUID: "serviceAccountUID_example", + signerName: "signerName_example", + unverifiedUserAnnotations: { + "key": "key_example", + }, + }, + status: { + beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), + certificateChain: "certificateChain_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + notAfter: new Date('1970-01-01T00:00:00.00Z'), + notBefore: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodCertificateRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1PodCertificateRequest**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1PodCertificateRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CoordinationApi.md b/src/gen/docs/CoordinationApi.md new file mode 100644 index 0000000000..f56bfbd1b6 --- /dev/null +++ b/src/gen/docs/CoordinationApi.md @@ -0,0 +1,57 @@ +# .CoordinationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](CoordinationApi.md#getAPIGroup) | **GET** /apis/coordination.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, CoordinationApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CoordinationV1Api.md b/src/gen/docs/CoordinationV1Api.md new file mode 100644 index 0000000000..97de52c819 --- /dev/null +++ b/src/gen/docs/CoordinationV1Api.md @@ -0,0 +1,830 @@ +# .CoordinationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLease**](CoordinationV1Api.md#createNamespacedLease) | **POST** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | +[**deleteCollectionNamespacedLease**](CoordinationV1Api.md#deleteCollectionNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | +[**deleteNamespacedLease**](CoordinationV1Api.md#deleteNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | +[**getAPIResources**](CoordinationV1Api.md#getAPIResources) | **GET** /apis/coordination.k8s.io/v1/ | +[**listLeaseForAllNamespaces**](CoordinationV1Api.md#listLeaseForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1/leases | +[**listNamespacedLease**](CoordinationV1Api.md#listNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | +[**patchNamespacedLease**](CoordinationV1Api.md#patchNamespacedLease) | **PATCH** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | +[**readNamespacedLease**](CoordinationV1Api.md#readNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | +[**replaceNamespacedLease**](CoordinationV1Api.md#replaceNamespacedLease) | **PUT** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | + + +# **createNamespacedLease** +> V1Lease createNamespacedLease(body) + +create a Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from ''; +import type { CoordinationV1ApiCreateNamespacedLeaseRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiCreateNamespacedLeaseRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + acquireTime: "acquireTime_example", + holderIdentity: "holderIdentity_example", + leaseDurationSeconds: 1, + leaseTransitions: 1, + preferredHolder: "preferredHolder_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Lease**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Lease** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedLease** +> V1Status deleteCollectionNamespacedLease() + +delete collection of Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from ''; +import type { CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedLease** +> V1Status deleteNamespacedLease() + +delete a Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from ''; +import type { CoordinationV1ApiDeleteNamespacedLeaseRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiDeleteNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listLeaseForAllNamespaces** +> V1LeaseList listLeaseForAllNamespaces() + +list or watch objects of kind Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from ''; +import type { CoordinationV1ApiListLeaseForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiListLeaseForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLeaseForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1LeaseList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedLease** +> V1LeaseList listNamespacedLease() + +list or watch objects of kind Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from ''; +import type { CoordinationV1ApiListNamespacedLeaseRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiListNamespacedLeaseRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1LeaseList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedLease** +> V1Lease patchNamespacedLease(body) + +partially update the specified Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from ''; +import type { CoordinationV1ApiPatchNamespacedLeaseRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiPatchNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Lease** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedLease** +> V1Lease readNamespacedLease() + +read the specified Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from ''; +import type { CoordinationV1ApiReadNamespacedLeaseRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiReadNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Lease** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedLease** +> V1Lease replaceNamespacedLease(body) + +replace the specified Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from ''; +import type { CoordinationV1ApiReplaceNamespacedLeaseRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiReplaceNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + acquireTime: "acquireTime_example", + holderIdentity: "holderIdentity_example", + leaseDurationSeconds: 1, + leaseTransitions: 1, + preferredHolder: "preferredHolder_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Lease**| | + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Lease** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CoordinationV1alpha2Api.md b/src/gen/docs/CoordinationV1alpha2Api.md new file mode 100644 index 0000000000..76d509e1bd --- /dev/null +++ b/src/gen/docs/CoordinationV1alpha2Api.md @@ -0,0 +1,828 @@ +# .CoordinationV1alpha2Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | +[**deleteCollectionNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | +[**deleteNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | +[**getAPIResources**](CoordinationV1alpha2Api.md#getAPIResources) | **GET** /apis/coordination.k8s.io/v1alpha2/ | +[**listLeaseCandidateForAllNamespaces**](CoordinationV1alpha2Api.md#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1alpha2/leasecandidates | +[**listNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | +[**patchNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | +[**readNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | +[**replaceNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | + + +# **createNamespacedLeaseCandidate** +> V1alpha2LeaseCandidate createNamespacedLeaseCandidate(body) + +create a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from ''; +import type { CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha2LeaseCandidate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha2LeaseCandidate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedLeaseCandidate** +> V1Status deleteCollectionNamespacedLeaseCandidate() + +delete collection of LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from ''; +import type { CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedLeaseCandidate** +> V1Status deleteNamespacedLeaseCandidate() + +delete a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from ''; +import type { CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listLeaseCandidateForAllNamespaces** +> V1alpha2LeaseCandidateList listLeaseCandidateForAllNamespaces() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from ''; +import type { CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1alpha2LeaseCandidateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedLeaseCandidate** +> V1alpha2LeaseCandidateList listNamespacedLeaseCandidate() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from ''; +import type { CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1alpha2LeaseCandidateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedLeaseCandidate** +> V1alpha2LeaseCandidate patchNamespacedLeaseCandidate(body) + +partially update the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from ''; +import type { CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1alpha2LeaseCandidate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedLeaseCandidate** +> V1alpha2LeaseCandidate readNamespacedLeaseCandidate() + +read the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from ''; +import type { CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1alpha2LeaseCandidate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedLeaseCandidate** +> V1alpha2LeaseCandidate replaceNamespacedLeaseCandidate(body) + +replace the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from ''; +import type { CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha2LeaseCandidate**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha2LeaseCandidate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CoordinationV1beta1Api.md b/src/gen/docs/CoordinationV1beta1Api.md new file mode 100644 index 0000000000..4451a068b5 --- /dev/null +++ b/src/gen/docs/CoordinationV1beta1Api.md @@ -0,0 +1,828 @@ +# .CoordinationV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | +[**deleteCollectionNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | +[**deleteNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | +[**getAPIResources**](CoordinationV1beta1Api.md#getAPIResources) | **GET** /apis/coordination.k8s.io/v1beta1/ | +[**listLeaseCandidateForAllNamespaces**](CoordinationV1beta1Api.md#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1beta1/leasecandidates | +[**listNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | +[**patchNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | +[**readNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | +[**replaceNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | + + +# **createNamespacedLeaseCandidate** +> V1beta1LeaseCandidate createNamespacedLeaseCandidate(body) + +create a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from ''; +import type { CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1LeaseCandidate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1LeaseCandidate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedLeaseCandidate** +> V1Status deleteCollectionNamespacedLeaseCandidate() + +delete collection of LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from ''; +import type { CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedLeaseCandidate** +> V1Status deleteNamespacedLeaseCandidate() + +delete a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from ''; +import type { CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listLeaseCandidateForAllNamespaces** +> V1beta1LeaseCandidateList listLeaseCandidateForAllNamespaces() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from ''; +import type { CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1LeaseCandidateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedLeaseCandidate** +> V1beta1LeaseCandidateList listNamespacedLeaseCandidate() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from ''; +import type { CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1LeaseCandidateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedLeaseCandidate** +> V1beta1LeaseCandidate patchNamespacedLeaseCandidate(body) + +partially update the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from ''; +import type { CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1LeaseCandidate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedLeaseCandidate** +> V1beta1LeaseCandidate readNamespacedLeaseCandidate() + +read the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from ''; +import type { CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1LeaseCandidate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedLeaseCandidate** +> V1beta1LeaseCandidate replaceNamespacedLeaseCandidate(body) + +replace the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from ''; +import type { CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1LeaseCandidate**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1LeaseCandidate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CoreApi.md b/src/gen/docs/CoreApi.md new file mode 100644 index 0000000000..3156b4ac61 --- /dev/null +++ b/src/gen/docs/CoreApi.md @@ -0,0 +1,57 @@ +# .CoreApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIVersions**](CoreApi.md#getAPIVersions) | **GET** /api/ | + + +# **getAPIVersions** +> V1APIVersions getAPIVersions() + +get available API versions + +### Example + + +```typescript +import { createConfiguration, CoreApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIVersions(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIVersions** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CoreV1Api.md b/src/gen/docs/CoreV1Api.md new file mode 100644 index 0000000000..5410fe8200 --- /dev/null +++ b/src/gen/docs/CoreV1Api.md @@ -0,0 +1,39216 @@ +# .CoreV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**connectDeleteNamespacedPodProxy**](CoreV1Api.md#connectDeleteNamespacedPodProxy) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectDeleteNamespacedPodProxyWithPath**](CoreV1Api.md#connectDeleteNamespacedPodProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectDeleteNamespacedServiceProxy**](CoreV1Api.md#connectDeleteNamespacedServiceProxy) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectDeleteNamespacedServiceProxyWithPath**](CoreV1Api.md#connectDeleteNamespacedServiceProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectDeleteNodeProxy**](CoreV1Api.md#connectDeleteNodeProxy) | **DELETE** /api/v1/nodes/{name}/proxy | +[**connectDeleteNodeProxyWithPath**](CoreV1Api.md#connectDeleteNodeProxyWithPath) | **DELETE** /api/v1/nodes/{name}/proxy/{path} | +[**connectGetNamespacedPodAttach**](CoreV1Api.md#connectGetNamespacedPodAttach) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/attach | +[**connectGetNamespacedPodExec**](CoreV1Api.md#connectGetNamespacedPodExec) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/exec | +[**connectGetNamespacedPodPortforward**](CoreV1Api.md#connectGetNamespacedPodPortforward) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/portforward | +[**connectGetNamespacedPodProxy**](CoreV1Api.md#connectGetNamespacedPodProxy) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectGetNamespacedPodProxyWithPath**](CoreV1Api.md#connectGetNamespacedPodProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectGetNamespacedServiceProxy**](CoreV1Api.md#connectGetNamespacedServiceProxy) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectGetNamespacedServiceProxyWithPath**](CoreV1Api.md#connectGetNamespacedServiceProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectGetNodeProxy**](CoreV1Api.md#connectGetNodeProxy) | **GET** /api/v1/nodes/{name}/proxy | +[**connectGetNodeProxyWithPath**](CoreV1Api.md#connectGetNodeProxyWithPath) | **GET** /api/v1/nodes/{name}/proxy/{path} | +[**connectHeadNamespacedPodProxy**](CoreV1Api.md#connectHeadNamespacedPodProxy) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectHeadNamespacedPodProxyWithPath**](CoreV1Api.md#connectHeadNamespacedPodProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectHeadNamespacedServiceProxy**](CoreV1Api.md#connectHeadNamespacedServiceProxy) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectHeadNamespacedServiceProxyWithPath**](CoreV1Api.md#connectHeadNamespacedServiceProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectHeadNodeProxy**](CoreV1Api.md#connectHeadNodeProxy) | **HEAD** /api/v1/nodes/{name}/proxy | +[**connectHeadNodeProxyWithPath**](CoreV1Api.md#connectHeadNodeProxyWithPath) | **HEAD** /api/v1/nodes/{name}/proxy/{path} | +[**connectOptionsNamespacedPodProxy**](CoreV1Api.md#connectOptionsNamespacedPodProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectOptionsNamespacedPodProxyWithPath**](CoreV1Api.md#connectOptionsNamespacedPodProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectOptionsNamespacedServiceProxy**](CoreV1Api.md#connectOptionsNamespacedServiceProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectOptionsNamespacedServiceProxyWithPath**](CoreV1Api.md#connectOptionsNamespacedServiceProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectOptionsNodeProxy**](CoreV1Api.md#connectOptionsNodeProxy) | **OPTIONS** /api/v1/nodes/{name}/proxy | +[**connectOptionsNodeProxyWithPath**](CoreV1Api.md#connectOptionsNodeProxyWithPath) | **OPTIONS** /api/v1/nodes/{name}/proxy/{path} | +[**connectPatchNamespacedPodProxy**](CoreV1Api.md#connectPatchNamespacedPodProxy) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectPatchNamespacedPodProxyWithPath**](CoreV1Api.md#connectPatchNamespacedPodProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectPatchNamespacedServiceProxy**](CoreV1Api.md#connectPatchNamespacedServiceProxy) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectPatchNamespacedServiceProxyWithPath**](CoreV1Api.md#connectPatchNamespacedServiceProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectPatchNodeProxy**](CoreV1Api.md#connectPatchNodeProxy) | **PATCH** /api/v1/nodes/{name}/proxy | +[**connectPatchNodeProxyWithPath**](CoreV1Api.md#connectPatchNodeProxyWithPath) | **PATCH** /api/v1/nodes/{name}/proxy/{path} | +[**connectPostNamespacedPodAttach**](CoreV1Api.md#connectPostNamespacedPodAttach) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/attach | +[**connectPostNamespacedPodExec**](CoreV1Api.md#connectPostNamespacedPodExec) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/exec | +[**connectPostNamespacedPodPortforward**](CoreV1Api.md#connectPostNamespacedPodPortforward) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/portforward | +[**connectPostNamespacedPodProxy**](CoreV1Api.md#connectPostNamespacedPodProxy) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectPostNamespacedPodProxyWithPath**](CoreV1Api.md#connectPostNamespacedPodProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectPostNamespacedServiceProxy**](CoreV1Api.md#connectPostNamespacedServiceProxy) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectPostNamespacedServiceProxyWithPath**](CoreV1Api.md#connectPostNamespacedServiceProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectPostNodeProxy**](CoreV1Api.md#connectPostNodeProxy) | **POST** /api/v1/nodes/{name}/proxy | +[**connectPostNodeProxyWithPath**](CoreV1Api.md#connectPostNodeProxyWithPath) | **POST** /api/v1/nodes/{name}/proxy/{path} | +[**connectPutNamespacedPodProxy**](CoreV1Api.md#connectPutNamespacedPodProxy) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectPutNamespacedPodProxyWithPath**](CoreV1Api.md#connectPutNamespacedPodProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectPutNamespacedServiceProxy**](CoreV1Api.md#connectPutNamespacedServiceProxy) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectPutNamespacedServiceProxyWithPath**](CoreV1Api.md#connectPutNamespacedServiceProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectPutNodeProxy**](CoreV1Api.md#connectPutNodeProxy) | **PUT** /api/v1/nodes/{name}/proxy | +[**connectPutNodeProxyWithPath**](CoreV1Api.md#connectPutNodeProxyWithPath) | **PUT** /api/v1/nodes/{name}/proxy/{path} | +[**createNamespace**](CoreV1Api.md#createNamespace) | **POST** /api/v1/namespaces | +[**createNamespacedBinding**](CoreV1Api.md#createNamespacedBinding) | **POST** /api/v1/namespaces/{namespace}/bindings | +[**createNamespacedConfigMap**](CoreV1Api.md#createNamespacedConfigMap) | **POST** /api/v1/namespaces/{namespace}/configmaps | +[**createNamespacedEndpoints**](CoreV1Api.md#createNamespacedEndpoints) | **POST** /api/v1/namespaces/{namespace}/endpoints | +[**createNamespacedEvent**](CoreV1Api.md#createNamespacedEvent) | **POST** /api/v1/namespaces/{namespace}/events | +[**createNamespacedLimitRange**](CoreV1Api.md#createNamespacedLimitRange) | **POST** /api/v1/namespaces/{namespace}/limitranges | +[**createNamespacedPersistentVolumeClaim**](CoreV1Api.md#createNamespacedPersistentVolumeClaim) | **POST** /api/v1/namespaces/{namespace}/persistentvolumeclaims | +[**createNamespacedPod**](CoreV1Api.md#createNamespacedPod) | **POST** /api/v1/namespaces/{namespace}/pods | +[**createNamespacedPodBinding**](CoreV1Api.md#createNamespacedPodBinding) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/binding | +[**createNamespacedPodEviction**](CoreV1Api.md#createNamespacedPodEviction) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/eviction | +[**createNamespacedPodTemplate**](CoreV1Api.md#createNamespacedPodTemplate) | **POST** /api/v1/namespaces/{namespace}/podtemplates | +[**createNamespacedReplicationController**](CoreV1Api.md#createNamespacedReplicationController) | **POST** /api/v1/namespaces/{namespace}/replicationcontrollers | +[**createNamespacedResourceQuota**](CoreV1Api.md#createNamespacedResourceQuota) | **POST** /api/v1/namespaces/{namespace}/resourcequotas | +[**createNamespacedSecret**](CoreV1Api.md#createNamespacedSecret) | **POST** /api/v1/namespaces/{namespace}/secrets | +[**createNamespacedService**](CoreV1Api.md#createNamespacedService) | **POST** /api/v1/namespaces/{namespace}/services | +[**createNamespacedServiceAccount**](CoreV1Api.md#createNamespacedServiceAccount) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts | +[**createNamespacedServiceAccountToken**](CoreV1Api.md#createNamespacedServiceAccountToken) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token | +[**createNode**](CoreV1Api.md#createNode) | **POST** /api/v1/nodes | +[**createPersistentVolume**](CoreV1Api.md#createPersistentVolume) | **POST** /api/v1/persistentvolumes | +[**deleteCollectionNamespacedConfigMap**](CoreV1Api.md#deleteCollectionNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps | +[**deleteCollectionNamespacedEndpoints**](CoreV1Api.md#deleteCollectionNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints | +[**deleteCollectionNamespacedEvent**](CoreV1Api.md#deleteCollectionNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events | +[**deleteCollectionNamespacedLimitRange**](CoreV1Api.md#deleteCollectionNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges | +[**deleteCollectionNamespacedPersistentVolumeClaim**](CoreV1Api.md#deleteCollectionNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims | +[**deleteCollectionNamespacedPod**](CoreV1Api.md#deleteCollectionNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods | +[**deleteCollectionNamespacedPodTemplate**](CoreV1Api.md#deleteCollectionNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates | +[**deleteCollectionNamespacedReplicationController**](CoreV1Api.md#deleteCollectionNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers | +[**deleteCollectionNamespacedResourceQuota**](CoreV1Api.md#deleteCollectionNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas | +[**deleteCollectionNamespacedSecret**](CoreV1Api.md#deleteCollectionNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets | +[**deleteCollectionNamespacedService**](CoreV1Api.md#deleteCollectionNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services | +[**deleteCollectionNamespacedServiceAccount**](CoreV1Api.md#deleteCollectionNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts | +[**deleteCollectionNode**](CoreV1Api.md#deleteCollectionNode) | **DELETE** /api/v1/nodes | +[**deleteCollectionPersistentVolume**](CoreV1Api.md#deleteCollectionPersistentVolume) | **DELETE** /api/v1/persistentvolumes | +[**deleteNamespace**](CoreV1Api.md#deleteNamespace) | **DELETE** /api/v1/namespaces/{name} | +[**deleteNamespacedConfigMap**](CoreV1Api.md#deleteNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**deleteNamespacedEndpoints**](CoreV1Api.md#deleteNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**deleteNamespacedEvent**](CoreV1Api.md#deleteNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events/{name} | +[**deleteNamespacedLimitRange**](CoreV1Api.md#deleteNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**deleteNamespacedPersistentVolumeClaim**](CoreV1Api.md#deleteNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**deleteNamespacedPod**](CoreV1Api.md#deleteNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name} | +[**deleteNamespacedPodTemplate**](CoreV1Api.md#deleteNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**deleteNamespacedReplicationController**](CoreV1Api.md#deleteNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**deleteNamespacedResourceQuota**](CoreV1Api.md#deleteNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**deleteNamespacedSecret**](CoreV1Api.md#deleteNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets/{name} | +[**deleteNamespacedService**](CoreV1Api.md#deleteNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services/{name} | +[**deleteNamespacedServiceAccount**](CoreV1Api.md#deleteNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**deleteNode**](CoreV1Api.md#deleteNode) | **DELETE** /api/v1/nodes/{name} | +[**deletePersistentVolume**](CoreV1Api.md#deletePersistentVolume) | **DELETE** /api/v1/persistentvolumes/{name} | +[**getAPIResources**](CoreV1Api.md#getAPIResources) | **GET** /api/v1/ | +[**listComponentStatus**](CoreV1Api.md#listComponentStatus) | **GET** /api/v1/componentstatuses | +[**listConfigMapForAllNamespaces**](CoreV1Api.md#listConfigMapForAllNamespaces) | **GET** /api/v1/configmaps | +[**listEndpointsForAllNamespaces**](CoreV1Api.md#listEndpointsForAllNamespaces) | **GET** /api/v1/endpoints | +[**listEventForAllNamespaces**](CoreV1Api.md#listEventForAllNamespaces) | **GET** /api/v1/events | +[**listLimitRangeForAllNamespaces**](CoreV1Api.md#listLimitRangeForAllNamespaces) | **GET** /api/v1/limitranges | +[**listNamespace**](CoreV1Api.md#listNamespace) | **GET** /api/v1/namespaces | +[**listNamespacedConfigMap**](CoreV1Api.md#listNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps | +[**listNamespacedEndpoints**](CoreV1Api.md#listNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints | +[**listNamespacedEvent**](CoreV1Api.md#listNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events | +[**listNamespacedLimitRange**](CoreV1Api.md#listNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges | +[**listNamespacedPersistentVolumeClaim**](CoreV1Api.md#listNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims | +[**listNamespacedPod**](CoreV1Api.md#listNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods | +[**listNamespacedPodTemplate**](CoreV1Api.md#listNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates | +[**listNamespacedReplicationController**](CoreV1Api.md#listNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers | +[**listNamespacedResourceQuota**](CoreV1Api.md#listNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas | +[**listNamespacedSecret**](CoreV1Api.md#listNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets | +[**listNamespacedService**](CoreV1Api.md#listNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services | +[**listNamespacedServiceAccount**](CoreV1Api.md#listNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts | +[**listNode**](CoreV1Api.md#listNode) | **GET** /api/v1/nodes | +[**listPersistentVolume**](CoreV1Api.md#listPersistentVolume) | **GET** /api/v1/persistentvolumes | +[**listPersistentVolumeClaimForAllNamespaces**](CoreV1Api.md#listPersistentVolumeClaimForAllNamespaces) | **GET** /api/v1/persistentvolumeclaims | +[**listPodForAllNamespaces**](CoreV1Api.md#listPodForAllNamespaces) | **GET** /api/v1/pods | +[**listPodTemplateForAllNamespaces**](CoreV1Api.md#listPodTemplateForAllNamespaces) | **GET** /api/v1/podtemplates | +[**listReplicationControllerForAllNamespaces**](CoreV1Api.md#listReplicationControllerForAllNamespaces) | **GET** /api/v1/replicationcontrollers | +[**listResourceQuotaForAllNamespaces**](CoreV1Api.md#listResourceQuotaForAllNamespaces) | **GET** /api/v1/resourcequotas | +[**listSecretForAllNamespaces**](CoreV1Api.md#listSecretForAllNamespaces) | **GET** /api/v1/secrets | +[**listServiceAccountForAllNamespaces**](CoreV1Api.md#listServiceAccountForAllNamespaces) | **GET** /api/v1/serviceaccounts | +[**listServiceForAllNamespaces**](CoreV1Api.md#listServiceForAllNamespaces) | **GET** /api/v1/services | +[**patchNamespace**](CoreV1Api.md#patchNamespace) | **PATCH** /api/v1/namespaces/{name} | +[**patchNamespaceStatus**](CoreV1Api.md#patchNamespaceStatus) | **PATCH** /api/v1/namespaces/{name}/status | +[**patchNamespacedConfigMap**](CoreV1Api.md#patchNamespacedConfigMap) | **PATCH** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**patchNamespacedEndpoints**](CoreV1Api.md#patchNamespacedEndpoints) | **PATCH** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**patchNamespacedEvent**](CoreV1Api.md#patchNamespacedEvent) | **PATCH** /api/v1/namespaces/{namespace}/events/{name} | +[**patchNamespacedLimitRange**](CoreV1Api.md#patchNamespacedLimitRange) | **PATCH** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**patchNamespacedPersistentVolumeClaim**](CoreV1Api.md#patchNamespacedPersistentVolumeClaim) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**patchNamespacedPersistentVolumeClaimStatus**](CoreV1Api.md#patchNamespacedPersistentVolumeClaimStatus) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | +[**patchNamespacedPod**](CoreV1Api.md#patchNamespacedPod) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name} | +[**patchNamespacedPodEphemeralcontainers**](CoreV1Api.md#patchNamespacedPodEphemeralcontainers) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | +[**patchNamespacedPodResize**](CoreV1Api.md#patchNamespacedPodResize) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/resize | +[**patchNamespacedPodStatus**](CoreV1Api.md#patchNamespacedPodStatus) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/status | +[**patchNamespacedPodTemplate**](CoreV1Api.md#patchNamespacedPodTemplate) | **PATCH** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**patchNamespacedReplicationController**](CoreV1Api.md#patchNamespacedReplicationController) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**patchNamespacedReplicationControllerScale**](CoreV1Api.md#patchNamespacedReplicationControllerScale) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | +[**patchNamespacedReplicationControllerStatus**](CoreV1Api.md#patchNamespacedReplicationControllerStatus) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | +[**patchNamespacedResourceQuota**](CoreV1Api.md#patchNamespacedResourceQuota) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**patchNamespacedResourceQuotaStatus**](CoreV1Api.md#patchNamespacedResourceQuotaStatus) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | +[**patchNamespacedSecret**](CoreV1Api.md#patchNamespacedSecret) | **PATCH** /api/v1/namespaces/{namespace}/secrets/{name} | +[**patchNamespacedService**](CoreV1Api.md#patchNamespacedService) | **PATCH** /api/v1/namespaces/{namespace}/services/{name} | +[**patchNamespacedServiceAccount**](CoreV1Api.md#patchNamespacedServiceAccount) | **PATCH** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**patchNamespacedServiceStatus**](CoreV1Api.md#patchNamespacedServiceStatus) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/status | +[**patchNode**](CoreV1Api.md#patchNode) | **PATCH** /api/v1/nodes/{name} | +[**patchNodeStatus**](CoreV1Api.md#patchNodeStatus) | **PATCH** /api/v1/nodes/{name}/status | +[**patchPersistentVolume**](CoreV1Api.md#patchPersistentVolume) | **PATCH** /api/v1/persistentvolumes/{name} | +[**patchPersistentVolumeStatus**](CoreV1Api.md#patchPersistentVolumeStatus) | **PATCH** /api/v1/persistentvolumes/{name}/status | +[**readComponentStatus**](CoreV1Api.md#readComponentStatus) | **GET** /api/v1/componentstatuses/{name} | +[**readNamespace**](CoreV1Api.md#readNamespace) | **GET** /api/v1/namespaces/{name} | +[**readNamespaceStatus**](CoreV1Api.md#readNamespaceStatus) | **GET** /api/v1/namespaces/{name}/status | +[**readNamespacedConfigMap**](CoreV1Api.md#readNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**readNamespacedEndpoints**](CoreV1Api.md#readNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**readNamespacedEvent**](CoreV1Api.md#readNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events/{name} | +[**readNamespacedLimitRange**](CoreV1Api.md#readNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**readNamespacedPersistentVolumeClaim**](CoreV1Api.md#readNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**readNamespacedPersistentVolumeClaimStatus**](CoreV1Api.md#readNamespacedPersistentVolumeClaimStatus) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | +[**readNamespacedPod**](CoreV1Api.md#readNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods/{name} | +[**readNamespacedPodEphemeralcontainers**](CoreV1Api.md#readNamespacedPodEphemeralcontainers) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | +[**readNamespacedPodLog**](CoreV1Api.md#readNamespacedPodLog) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/log | +[**readNamespacedPodResize**](CoreV1Api.md#readNamespacedPodResize) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/resize | +[**readNamespacedPodStatus**](CoreV1Api.md#readNamespacedPodStatus) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/status | +[**readNamespacedPodTemplate**](CoreV1Api.md#readNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**readNamespacedReplicationController**](CoreV1Api.md#readNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**readNamespacedReplicationControllerScale**](CoreV1Api.md#readNamespacedReplicationControllerScale) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | +[**readNamespacedReplicationControllerStatus**](CoreV1Api.md#readNamespacedReplicationControllerStatus) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | +[**readNamespacedResourceQuota**](CoreV1Api.md#readNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**readNamespacedResourceQuotaStatus**](CoreV1Api.md#readNamespacedResourceQuotaStatus) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | +[**readNamespacedSecret**](CoreV1Api.md#readNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets/{name} | +[**readNamespacedService**](CoreV1Api.md#readNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services/{name} | +[**readNamespacedServiceAccount**](CoreV1Api.md#readNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**readNamespacedServiceStatus**](CoreV1Api.md#readNamespacedServiceStatus) | **GET** /api/v1/namespaces/{namespace}/services/{name}/status | +[**readNode**](CoreV1Api.md#readNode) | **GET** /api/v1/nodes/{name} | +[**readNodeStatus**](CoreV1Api.md#readNodeStatus) | **GET** /api/v1/nodes/{name}/status | +[**readPersistentVolume**](CoreV1Api.md#readPersistentVolume) | **GET** /api/v1/persistentvolumes/{name} | +[**readPersistentVolumeStatus**](CoreV1Api.md#readPersistentVolumeStatus) | **GET** /api/v1/persistentvolumes/{name}/status | +[**replaceNamespace**](CoreV1Api.md#replaceNamespace) | **PUT** /api/v1/namespaces/{name} | +[**replaceNamespaceFinalize**](CoreV1Api.md#replaceNamespaceFinalize) | **PUT** /api/v1/namespaces/{name}/finalize | +[**replaceNamespaceStatus**](CoreV1Api.md#replaceNamespaceStatus) | **PUT** /api/v1/namespaces/{name}/status | +[**replaceNamespacedConfigMap**](CoreV1Api.md#replaceNamespacedConfigMap) | **PUT** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**replaceNamespacedEndpoints**](CoreV1Api.md#replaceNamespacedEndpoints) | **PUT** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**replaceNamespacedEvent**](CoreV1Api.md#replaceNamespacedEvent) | **PUT** /api/v1/namespaces/{namespace}/events/{name} | +[**replaceNamespacedLimitRange**](CoreV1Api.md#replaceNamespacedLimitRange) | **PUT** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**replaceNamespacedPersistentVolumeClaim**](CoreV1Api.md#replaceNamespacedPersistentVolumeClaim) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**replaceNamespacedPersistentVolumeClaimStatus**](CoreV1Api.md#replaceNamespacedPersistentVolumeClaimStatus) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | +[**replaceNamespacedPod**](CoreV1Api.md#replaceNamespacedPod) | **PUT** /api/v1/namespaces/{namespace}/pods/{name} | +[**replaceNamespacedPodEphemeralcontainers**](CoreV1Api.md#replaceNamespacedPodEphemeralcontainers) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | +[**replaceNamespacedPodResize**](CoreV1Api.md#replaceNamespacedPodResize) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/resize | +[**replaceNamespacedPodStatus**](CoreV1Api.md#replaceNamespacedPodStatus) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/status | +[**replaceNamespacedPodTemplate**](CoreV1Api.md#replaceNamespacedPodTemplate) | **PUT** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**replaceNamespacedReplicationController**](CoreV1Api.md#replaceNamespacedReplicationController) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**replaceNamespacedReplicationControllerScale**](CoreV1Api.md#replaceNamespacedReplicationControllerScale) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | +[**replaceNamespacedReplicationControllerStatus**](CoreV1Api.md#replaceNamespacedReplicationControllerStatus) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | +[**replaceNamespacedResourceQuota**](CoreV1Api.md#replaceNamespacedResourceQuota) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**replaceNamespacedResourceQuotaStatus**](CoreV1Api.md#replaceNamespacedResourceQuotaStatus) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | +[**replaceNamespacedSecret**](CoreV1Api.md#replaceNamespacedSecret) | **PUT** /api/v1/namespaces/{namespace}/secrets/{name} | +[**replaceNamespacedService**](CoreV1Api.md#replaceNamespacedService) | **PUT** /api/v1/namespaces/{namespace}/services/{name} | +[**replaceNamespacedServiceAccount**](CoreV1Api.md#replaceNamespacedServiceAccount) | **PUT** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**replaceNamespacedServiceStatus**](CoreV1Api.md#replaceNamespacedServiceStatus) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/status | +[**replaceNode**](CoreV1Api.md#replaceNode) | **PUT** /api/v1/nodes/{name} | +[**replaceNodeStatus**](CoreV1Api.md#replaceNodeStatus) | **PUT** /api/v1/nodes/{name}/status | +[**replacePersistentVolume**](CoreV1Api.md#replacePersistentVolume) | **PUT** /api/v1/persistentvolumes/{name} | +[**replacePersistentVolumeStatus**](CoreV1Api.md#replacePersistentVolumeStatus) | **PUT** /api/v1/persistentvolumes/{name}/status | + + +# **connectDeleteNamespacedPodProxy** +> string connectDeleteNamespacedPodProxy() + +connect DELETE requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectDeleteNamespacedPodProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectDeleteNamespacedPodProxyWithPath** +> string connectDeleteNamespacedPodProxyWithPath() + +connect DELETE requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectDeleteNamespacedServiceProxy** +> string connectDeleteNamespacedServiceProxy() + +connect DELETE requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectDeleteNamespacedServiceProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectDeleteNamespacedServiceProxyWithPath** +> string connectDeleteNamespacedServiceProxyWithPath() + +connect DELETE requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectDeleteNodeProxy** +> string connectDeleteNodeProxy() + +connect DELETE requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectDeleteNodeProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectDeleteNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectDeleteNodeProxyWithPath** +> string connectDeleteNodeProxyWithPath() + +connect DELETE requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectDeleteNodeProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectDeleteNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectGetNamespacedPodAttach** +> string connectGetNamespacedPodAttach() + +connect GET requests to attach of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectGetNamespacedPodAttachRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodAttachRequest = { + // name of the PodAttachOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) + stderr: true, + // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectGetNamespacedPodAttach(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodAttachOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectGetNamespacedPodExec** +> string connectGetNamespacedPodExec() + +connect GET requests to exec of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectGetNamespacedPodExecRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodExecRequest = { + // name of the PodExecOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Command is the remote command to execute. argv array. Not executed within a shell. (optional) + command: "command_example", + // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Redirect the standard error stream of the pod for this call. (optional) + stderr: true, + // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Redirect the standard output stream of the pod for this call. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectGetNamespacedPodExec(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodExecOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined + **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined + **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectGetNamespacedPodPortforward** +> string connectGetNamespacedPodPortforward() + +connect GET requests to portforward of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectGetNamespacedPodPortforwardRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodPortforwardRequest = { + // name of the PodPortForwardOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // List of ports to forward Required when using WebSockets (optional) + ports: 1, +}; + +const data = await apiInstance.connectGetNamespacedPodPortforward(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectGetNamespacedPodProxy** +> string connectGetNamespacedPodProxy() + +connect GET requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectGetNamespacedPodProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectGetNamespacedPodProxyWithPath** +> string connectGetNamespacedPodProxyWithPath() + +connect GET requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectGetNamespacedServiceProxy** +> string connectGetNamespacedServiceProxy() + +connect GET requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectGetNamespacedServiceProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectGetNamespacedServiceProxyWithPath** +> string connectGetNamespacedServiceProxyWithPath() + +connect GET requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectGetNodeProxy** +> string connectGetNodeProxy() + +connect GET requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectGetNodeProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectGetNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectGetNodeProxyWithPath** +> string connectGetNodeProxyWithPath() + +connect GET requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectGetNodeProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectGetNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectHeadNamespacedPodProxy** +> string connectHeadNamespacedPodProxy() + +connect HEAD requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectHeadNamespacedPodProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectHeadNamespacedPodProxyWithPath** +> string connectHeadNamespacedPodProxyWithPath() + +connect HEAD requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectHeadNamespacedServiceProxy** +> string connectHeadNamespacedServiceProxy() + +connect HEAD requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectHeadNamespacedServiceProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectHeadNamespacedServiceProxyWithPath** +> string connectHeadNamespacedServiceProxyWithPath() + +connect HEAD requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectHeadNodeProxy** +> string connectHeadNodeProxy() + +connect HEAD requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectHeadNodeProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectHeadNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectHeadNodeProxyWithPath** +> string connectHeadNodeProxyWithPath() + +connect HEAD requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectHeadNodeProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectHeadNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectOptionsNamespacedPodProxy** +> string connectOptionsNamespacedPodProxy() + +connect OPTIONS requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectOptionsNamespacedPodProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectOptionsNamespacedPodProxyWithPath** +> string connectOptionsNamespacedPodProxyWithPath() + +connect OPTIONS requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectOptionsNamespacedServiceProxy** +> string connectOptionsNamespacedServiceProxy() + +connect OPTIONS requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectOptionsNamespacedServiceProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectOptionsNamespacedServiceProxyWithPath** +> string connectOptionsNamespacedServiceProxyWithPath() + +connect OPTIONS requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectOptionsNodeProxy** +> string connectOptionsNodeProxy() + +connect OPTIONS requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectOptionsNodeProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectOptionsNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectOptionsNodeProxyWithPath** +> string connectOptionsNodeProxyWithPath() + +connect OPTIONS requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectOptionsNodeProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectOptionsNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPatchNamespacedPodProxy** +> string connectPatchNamespacedPodProxy() + +connect PATCH requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPatchNamespacedPodProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPatchNamespacedPodProxyWithPath** +> string connectPatchNamespacedPodProxyWithPath() + +connect PATCH requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPatchNamespacedServiceProxy** +> string connectPatchNamespacedServiceProxy() + +connect PATCH requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPatchNamespacedServiceProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPatchNamespacedServiceProxyWithPath** +> string connectPatchNamespacedServiceProxyWithPath() + +connect PATCH requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPatchNodeProxy** +> string connectPatchNodeProxy() + +connect PATCH requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPatchNodeProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPatchNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPatchNodeProxyWithPath** +> string connectPatchNodeProxyWithPath() + +connect PATCH requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPatchNodeProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPatchNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPostNamespacedPodAttach** +> string connectPostNamespacedPodAttach() + +connect POST requests to attach of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPostNamespacedPodAttachRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodAttachRequest = { + // name of the PodAttachOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) + stderr: true, + // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectPostNamespacedPodAttach(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodAttachOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPostNamespacedPodExec** +> string connectPostNamespacedPodExec() + +connect POST requests to exec of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPostNamespacedPodExecRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodExecRequest = { + // name of the PodExecOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Command is the remote command to execute. argv array. Not executed within a shell. (optional) + command: "command_example", + // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Redirect the standard error stream of the pod for this call. (optional) + stderr: true, + // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Redirect the standard output stream of the pod for this call. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectPostNamespacedPodExec(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodExecOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined + **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined + **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPostNamespacedPodPortforward** +> string connectPostNamespacedPodPortforward() + +connect POST requests to portforward of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPostNamespacedPodPortforwardRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodPortforwardRequest = { + // name of the PodPortForwardOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // List of ports to forward Required when using WebSockets (optional) + ports: 1, +}; + +const data = await apiInstance.connectPostNamespacedPodPortforward(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPostNamespacedPodProxy** +> string connectPostNamespacedPodProxy() + +connect POST requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPostNamespacedPodProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPostNamespacedPodProxyWithPath** +> string connectPostNamespacedPodProxyWithPath() + +connect POST requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPostNamespacedServiceProxy** +> string connectPostNamespacedServiceProxy() + +connect POST requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPostNamespacedServiceProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPostNamespacedServiceProxyWithPath** +> string connectPostNamespacedServiceProxyWithPath() + +connect POST requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPostNodeProxy** +> string connectPostNodeProxy() + +connect POST requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPostNodeProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPostNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPostNodeProxyWithPath** +> string connectPostNodeProxyWithPath() + +connect POST requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPostNodeProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPostNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPutNamespacedPodProxy** +> string connectPutNamespacedPodProxy() + +connect PUT requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPutNamespacedPodProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPutNamespacedPodProxyWithPath** +> string connectPutNamespacedPodProxyWithPath() + +connect PUT requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPutNamespacedServiceProxy** +> string connectPutNamespacedServiceProxy() + +connect PUT requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPutNamespacedServiceProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPutNamespacedServiceProxyWithPath** +> string connectPutNamespacedServiceProxyWithPath() + +connect PUT requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPutNodeProxy** +> string connectPutNodeProxy() + +connect PUT requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPutNodeProxyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPutNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **connectPutNodeProxyWithPath** +> string connectPutNodeProxyWithPath() + +connect PUT requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiConnectPutNodeProxyWithPathRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPutNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespace** +> V1Namespace createNamespace(body) + +create a Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespaceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespaceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Namespace** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedBinding** +> V1Binding createNamespacedBinding(body) + +create a Binding + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + target: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Binding**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Binding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedConfigMap** +> V1ConfigMap createNamespacedConfigMap(body) + +create a ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedConfigMapRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedConfigMapRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + binaryData: { + "key": 'YQ==', + }, + data: { + "key": "key_example", + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ConfigMap**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ConfigMap** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedEndpoints** +> V1Endpoints createNamespacedEndpoints(body) + +create Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedEndpointsRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedEndpointsRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + subsets: [ + { + addresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + notReadyAddresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Endpoints**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Endpoints** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedEvent** +> CoreV1Event createNamespacedEvent(body) + +create an Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + count: 1, + eventTime: "eventTime_example", + firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + involvedObject: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + kind: "kind_example", + lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + reason: "reason_example", + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingComponent: "reportingComponent_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + source: { + component: "component_example", + host: "host_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **CoreV1Event**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**CoreV1Event** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedLimitRange** +> V1LimitRange createNamespacedLimitRange(body) + +create a LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedLimitRangeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedLimitRangeRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + limits: [ + { + _default: { + "key": "key_example", + }, + defaultRequest: { + "key": "key_example", + }, + max: { + "key": "key_example", + }, + maxLimitRequestRatio: { + "key": "key_example", + }, + min: { + "key": "key_example", + }, + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1LimitRange**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1LimitRange** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedPersistentVolumeClaim** +> V1PersistentVolumeClaim createNamespacedPersistentVolumeClaim(body) + +create a PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolumeClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedPod** +> V1Pod createNamespacedPod(body) + +create a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedPodRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedPodBinding** +> V1Binding createNamespacedPodBinding(body) + +create binding of a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedPodBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodBindingRequest = { + // name of the Binding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + target: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedPodBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Binding**| | + **name** | [**string**] | name of the Binding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Binding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedPodEviction** +> V1Eviction createNamespacedPodEviction(body) + +create eviction of a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedPodEvictionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodEvictionRequest = { + // name of the Eviction + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + deleteOptions: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedPodEviction(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Eviction**| | + **name** | [**string**] | name of the Eviction | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Eviction** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedPodTemplate** +> V1PodTemplate createNamespacedPodTemplate(body) + +create a PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedPodTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PodTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedReplicationController** +> V1ReplicationController createNamespacedReplicationController(body) + +create a ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedReplicationControllerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedReplicationControllerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + "key": "key_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicationController**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ReplicationController** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedResourceQuota** +> V1ResourceQuota createNamespacedResourceQuota(body) + +create a ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedResourceQuotaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedResourceQuotaRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + hard: { + "key": "key_example", + }, + scopeSelector: { + matchExpressions: [ + { + operator: "operator_example", + scopeName: "scopeName_example", + values: [ + "values_example", + ], + }, + ], + }, + scopes: [ + "scopes_example", + ], + }, + status: { + hard: { + "key": "key_example", + }, + used: { + "key": "key_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceQuota**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ResourceQuota** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedSecret** +> V1Secret createNamespacedSecret(body) + +create a Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedSecretRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedSecretRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: { + "key": 'YQ==', + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + stringData: { + "key": "key_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Secret**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Secret** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedService** +> V1Service createNamespacedService(body) + +create a Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedServiceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allocateLoadBalancerNodePorts: true, + clusterIP: "clusterIP_example", + clusterIPs: [ + "clusterIPs_example", + ], + externalIPs: [ + "externalIPs_example", + ], + externalName: "externalName_example", + externalTrafficPolicy: "externalTrafficPolicy_example", + healthCheckNodePort: 1, + internalTrafficPolicy: "internalTrafficPolicy_example", + ipFamilies: [ + "ipFamilies_example", + ], + ipFamilyPolicy: "ipFamilyPolicy_example", + loadBalancerClass: "loadBalancerClass_example", + loadBalancerIP: "loadBalancerIP_example", + loadBalancerSourceRanges: [ + "loadBalancerSourceRanges_example", + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + nodePort: 1, + port: 1, + protocol: "protocol_example", + targetPort: "targetPort_example", + }, + ], + publishNotReadyAddresses: true, + selector: { + "key": "key_example", + }, + sessionAffinity: "sessionAffinity_example", + sessionAffinityConfig: { + clientIP: { + timeoutSeconds: 1, + }, + }, + trafficDistribution: "trafficDistribution_example", + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ipMode: "ipMode_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Service**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Service** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedServiceAccount** +> V1ServiceAccount createNamespacedServiceAccount(body) + +create a ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedServiceAccountRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedServiceAccountRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + automountServiceAccountToken: true, + imagePullSecrets: [ + { + name: "name_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + secrets: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceAccount**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ServiceAccount** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedServiceAccountToken** +> AuthenticationV1TokenRequest createNamespacedServiceAccountToken(body) + +create token of a ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNamespacedServiceAccountTokenRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedServiceAccountTokenRequest = { + // name of the TokenRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + audiences: [ + "audiences_example", + ], + boundObjectRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + expirationSeconds: 1, + }, + status: { + expirationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + token: "token_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedServiceAccountToken(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **AuthenticationV1TokenRequest**| | + **name** | [**string**] | name of the TokenRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**AuthenticationV1TokenRequest** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNode** +> V1Node createNode(body) + +create a Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreateNodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNodeRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + configSource: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + externalID: "externalID_example", + podCIDR: "podCIDR_example", + podCIDRs: [ + "podCIDRs_example", + ], + providerID: "providerID_example", + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + unschedulable: true, + }, + status: { + addresses: [ + { + address: "address_example", + type: "type_example", + }, + ], + allocatable: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + config: { + active: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + assigned: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + error: "error_example", + lastKnownGood: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + }, + daemonEndpoints: { + kubeletEndpoint: { + Port: 1, + }, + }, + declaredFeatures: [ + "declaredFeatures_example", + ], + features: { + supplementalGroupsPolicy: true, + }, + images: [ + { + names: [ + "names_example", + ], + sizeBytes: 1, + }, + ], + nodeInfo: { + architecture: "architecture_example", + bootID: "bootID_example", + containerRuntimeVersion: "containerRuntimeVersion_example", + kernelVersion: "kernelVersion_example", + kubeProxyVersion: "kubeProxyVersion_example", + kubeletVersion: "kubeletVersion_example", + machineID: "machineID_example", + operatingSystem: "operatingSystem_example", + osImage: "osImage_example", + swap: { + capacity: 1, + }, + systemUUID: "systemUUID_example", + }, + phase: "phase_example", + runtimeHandlers: [ + { + features: { + recursiveReadOnlyMounts: true, + userNamespaces: true, + }, + name: "name_example", + }, + ], + volumesAttached: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumesInUse: [ + "volumesInUse_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Node**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Node** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createPersistentVolume** +> V1PersistentVolume createPersistentVolume(body) + +create a PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiCreatePersistentVolumeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreatePersistentVolumeRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + status: { + lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + phase: "phase_example", + reason: "reason_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolume**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolume** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedConfigMap** +> V1Status deleteCollectionNamespacedConfigMap() + +delete collection of ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedConfigMapRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedConfigMapRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedEndpoints** +> V1Status deleteCollectionNamespacedEndpoints() + +delete collection of Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedEndpointsRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedEndpointsRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedEvent** +> V1Status deleteCollectionNamespacedEvent() + +delete collection of Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedLimitRange** +> V1Status deleteCollectionNamespacedLimitRange() + +delete collection of LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedPersistentVolumeClaim** +> V1Status deleteCollectionNamespacedPersistentVolumeClaim() + +delete collection of PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedPod** +> V1Status deleteCollectionNamespacedPod() + +delete collection of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedPodRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedPodRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedPodTemplate** +> V1Status deleteCollectionNamespacedPodTemplate() + +delete collection of PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedReplicationController** +> V1Status deleteCollectionNamespacedReplicationController() + +delete collection of ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedResourceQuota** +> V1Status deleteCollectionNamespacedResourceQuota() + +delete collection of ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedSecret** +> V1Status deleteCollectionNamespacedSecret() + +delete collection of Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedSecretRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedSecretRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedService** +> V1Status deleteCollectionNamespacedService() + +delete collection of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedServiceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedServiceAccount** +> V1Status deleteCollectionNamespacedServiceAccount() + +delete collection of ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNode** +> V1Status deleteCollectionNode() + +delete collection of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionNodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionPersistentVolume** +> V1Status deleteCollectionPersistentVolume() + +delete collection of PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteCollectionPersistentVolumeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionPersistentVolumeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespace** +> V1Status deleteNamespace() + +delete a Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespaceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespaceRequest = { + // name of the Namespace + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedConfigMap** +> V1Status deleteNamespacedConfigMap() + +delete a ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedConfigMapRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedEndpoints** +> V1Status deleteNamespacedEndpoints() + +delete Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedEndpointsRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedEvent** +> V1Status deleteNamespacedEvent() + +delete an Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedLimitRange** +> V1Status deleteNamespacedLimitRange() + +delete a LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedLimitRangeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedPersistentVolumeClaim** +> V1PersistentVolumeClaim deleteNamespacedPersistentVolumeClaim() + +delete a PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedPod** +> V1Pod deleteNamespacedPod() + +delete a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedPodRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedPodTemplate** +> V1PodTemplate deleteNamespacedPodTemplate() + +delete a PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedPodTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1PodTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedReplicationController** +> V1Status deleteNamespacedReplicationController() + +delete a ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedReplicationControllerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedResourceQuota** +> V1ResourceQuota deleteNamespacedResourceQuota() + +delete a ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedResourceQuotaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1ResourceQuota** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedSecret** +> V1Status deleteNamespacedSecret() + +delete a Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedSecretRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedService** +> V1Service deleteNamespacedService() + +delete a Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Service** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedServiceAccount** +> V1ServiceAccount deleteNamespacedServiceAccount() + +delete a ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNamespacedServiceAccountRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1ServiceAccount** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNode** +> V1Status deleteNode() + +delete a Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeleteNodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNodeRequest = { + // name of the Node + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deletePersistentVolume** +> V1PersistentVolume deletePersistentVolume() + +delete a PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiDeletePersistentVolumeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeletePersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deletePersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolume** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listComponentStatus** +> V1ComponentStatusList listComponentStatus() + +list objects of kind ComponentStatus + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListComponentStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListComponentStatusRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listComponentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ComponentStatusList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listConfigMapForAllNamespaces** +> V1ConfigMapList listConfigMapForAllNamespaces() + +list or watch objects of kind ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListConfigMapForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListConfigMapForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listConfigMapForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ConfigMapList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listEndpointsForAllNamespaces** +> V1EndpointsList listEndpointsForAllNamespaces() + +list or watch objects of kind Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListEndpointsForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListEndpointsForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEndpointsForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1EndpointsList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listEventForAllNamespaces** +> CoreV1EventList listEventForAllNamespaces() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListEventForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListEventForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEventForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**CoreV1EventList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listLimitRangeForAllNamespaces** +> V1LimitRangeList listLimitRangeForAllNamespaces() + +list or watch objects of kind LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListLimitRangeForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListLimitRangeForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLimitRangeForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1LimitRangeList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespace** +> V1NamespaceList listNamespace() + +list or watch objects of kind Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespaceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespaceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1NamespaceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedConfigMap** +> V1ConfigMapList listNamespacedConfigMap() + +list or watch objects of kind ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedConfigMapRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedConfigMapRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ConfigMapList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedEndpoints** +> V1EndpointsList listNamespacedEndpoints() + +list or watch objects of kind Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedEndpointsRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedEndpointsRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1EndpointsList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedEvent** +> CoreV1EventList listNamespacedEvent() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**CoreV1EventList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedLimitRange** +> V1LimitRangeList listNamespacedLimitRange() + +list or watch objects of kind LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedLimitRangeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedLimitRangeRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1LimitRangeList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedPersistentVolumeClaim** +> V1PersistentVolumeClaimList listNamespacedPersistentVolumeClaim() + +list or watch objects of kind PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedPersistentVolumeClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedPersistentVolumeClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeClaimList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedPod** +> V1PodList listNamespacedPod() + +list or watch objects of kind Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedPodRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedPodRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PodList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedPodTemplate** +> V1PodTemplateList listNamespacedPodTemplate() + +list or watch objects of kind PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedPodTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedPodTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PodTemplateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedReplicationController** +> V1ReplicationControllerList listNamespacedReplicationController() + +list or watch objects of kind ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedReplicationControllerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedReplicationControllerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ReplicationControllerList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedResourceQuota** +> V1ResourceQuotaList listNamespacedResourceQuota() + +list or watch objects of kind ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedResourceQuotaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedResourceQuotaRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ResourceQuotaList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedSecret** +> V1SecretList listNamespacedSecret() + +list or watch objects of kind Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedSecretRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedSecretRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1SecretList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedService** +> V1ServiceList listNamespacedService() + +list or watch objects of kind Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedServiceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ServiceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedServiceAccount** +> V1ServiceAccountList listNamespacedServiceAccount() + +list or watch objects of kind ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNamespacedServiceAccountRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedServiceAccountRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ServiceAccountList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNode** +> V1NodeList listNode() + +list or watch objects of kind Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListNodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1NodeList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listPersistentVolume** +> V1PersistentVolumeList listPersistentVolume() + +list or watch objects of kind PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListPersistentVolumeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPersistentVolumeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listPersistentVolumeClaimForAllNamespaces** +> V1PersistentVolumeClaimList listPersistentVolumeClaimForAllNamespaces() + +list or watch objects of kind PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPersistentVolumeClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeClaimList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listPodForAllNamespaces** +> V1PodList listPodForAllNamespaces() + +list or watch objects of kind Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListPodForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPodForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PodList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listPodTemplateForAllNamespaces** +> V1PodTemplateList listPodTemplateForAllNamespaces() + +list or watch objects of kind PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListPodTemplateForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPodTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PodTemplateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listReplicationControllerForAllNamespaces** +> V1ReplicationControllerList listReplicationControllerForAllNamespaces() + +list or watch objects of kind ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListReplicationControllerForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListReplicationControllerForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listReplicationControllerForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ReplicationControllerList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listResourceQuotaForAllNamespaces** +> V1ResourceQuotaList listResourceQuotaForAllNamespaces() + +list or watch objects of kind ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListResourceQuotaForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListResourceQuotaForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceQuotaForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ResourceQuotaList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listSecretForAllNamespaces** +> V1SecretList listSecretForAllNamespaces() + +list or watch objects of kind Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListSecretForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListSecretForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listSecretForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1SecretList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listServiceAccountForAllNamespaces** +> V1ServiceAccountList listServiceAccountForAllNamespaces() + +list or watch objects of kind ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListServiceAccountForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListServiceAccountForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceAccountForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ServiceAccountList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listServiceForAllNamespaces** +> V1ServiceList listServiceForAllNamespaces() + +list or watch objects of kind Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiListServiceForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListServiceForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ServiceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespace** +> V1Namespace patchNamespace(body) + +partially update the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespaceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespaceRequest = { + // name of the Namespace + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Namespace** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespaceStatus** +> V1Namespace patchNamespaceStatus(body) + +partially update status of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespaceStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespaceStatusRequest = { + // name of the Namespace + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespaceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Namespace** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedConfigMap** +> V1ConfigMap patchNamespacedConfigMap(body) + +partially update the specified ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedConfigMapRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ConfigMap** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedEndpoints** +> V1Endpoints patchNamespacedEndpoints(body) + +partially update the specified Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedEndpointsRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Endpoints** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedEvent** +> CoreV1Event patchNamespacedEvent(body) + +partially update the specified Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**CoreV1Event** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedLimitRange** +> V1LimitRange patchNamespacedLimitRange(body) + +partially update the specified LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedLimitRangeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1LimitRange** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPersistentVolumeClaim** +> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaim(body) + +partially update the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPersistentVolumeClaimStatus** +> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaimStatus(body) + +partially update status of the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPersistentVolumeClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPod** +> V1Pod patchNamespacedPod(body) + +partially update the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedPodRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPodEphemeralcontainers** +> V1Pod patchNamespacedPodEphemeralcontainers(body) + +partially update ephemeralcontainers of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodEphemeralcontainers(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPodResize** +> V1Pod patchNamespacedPodResize(body) + +partially update resize of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedPodResizeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodResizeRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodResize(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPodStatus** +> V1Pod patchNamespacedPodStatus(body) + +partially update status of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedPodStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodStatusRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPodTemplate** +> V1PodTemplate patchNamespacedPodTemplate(body) + +partially update the specified PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedPodTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1PodTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedReplicationController** +> V1ReplicationController patchNamespacedReplicationController(body) + +partially update the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedReplicationControllerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ReplicationController** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedReplicationControllerScale** +> V1Scale patchNamespacedReplicationControllerScale(body) + +partially update scale of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedReplicationControllerScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedReplicationControllerScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicationControllerScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedReplicationControllerStatus** +> V1ReplicationController patchNamespacedReplicationControllerStatus(body) + +partially update status of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedReplicationControllerStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedReplicationControllerStatusRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicationControllerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ReplicationController** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceQuota** +> V1ResourceQuota patchNamespacedResourceQuota(body) + +partially update the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedResourceQuotaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ResourceQuota** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceQuotaStatus** +> V1ResourceQuota patchNamespacedResourceQuotaStatus(body) + +partially update status of the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedResourceQuotaStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedResourceQuotaStatusRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceQuotaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ResourceQuota** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedSecret** +> V1Secret patchNamespacedSecret(body) + +partially update the specified Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedSecretRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Secret** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedService** +> V1Service patchNamespacedService(body) + +partially update the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Service** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedServiceAccount** +> V1ServiceAccount patchNamespacedServiceAccount(body) + +partially update the specified ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedServiceAccountRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ServiceAccount** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedServiceStatus** +> V1Service patchNamespacedServiceStatus(body) + +partially update status of the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNamespacedServiceStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedServiceStatusRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Service** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNode** +> V1Node patchNode(body) + +partially update the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNodeRequest = { + // name of the Node + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Node** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNodeStatus** +> V1Node patchNodeStatus(body) + +partially update status of the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchNodeStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNodeStatusRequest = { + // name of the Node + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNodeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Node** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchPersistentVolume** +> V1PersistentVolume patchPersistentVolume(body) + +partially update the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchPersistentVolumeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchPersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolume** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchPersistentVolumeStatus** +> V1PersistentVolume patchPersistentVolumeStatus(body) + +partially update status of the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiPatchPersistentVolumeStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchPersistentVolumeStatusRequest = { + // name of the PersistentVolume + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPersistentVolumeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolume** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readComponentStatus** +> V1ComponentStatus readComponentStatus() + +read the specified ComponentStatus + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadComponentStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadComponentStatusRequest = { + // name of the ComponentStatus + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readComponentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ComponentStatus | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ComponentStatus** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespace** +> V1Namespace readNamespace() + +read the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespaceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespaceRequest = { + // name of the Namespace + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Namespace** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespaceStatus** +> V1Namespace readNamespaceStatus() + +read status of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespaceStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespaceStatusRequest = { + // name of the Namespace + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespaceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Namespace** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedConfigMap** +> V1ConfigMap readNamespacedConfigMap() + +read the specified ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedConfigMapRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ConfigMap** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedEndpoints** +> V1Endpoints readNamespacedEndpoints() + +read the specified Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedEndpointsRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Endpoints** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedEvent** +> CoreV1Event readNamespacedEvent() + +read the specified Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**CoreV1Event** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedLimitRange** +> V1LimitRange readNamespacedLimitRange() + +read the specified LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedLimitRangeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1LimitRange** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPersistentVolumeClaim** +> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaim() + +read the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedPersistentVolumeClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPersistentVolumeClaimStatus** +> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaimStatus() + +read status of the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPersistentVolumeClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPod** +> V1Pod readNamespacedPod() + +read the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedPodRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPodEphemeralcontainers** +> V1Pod readNamespacedPodEphemeralcontainers() + +read ephemeralcontainers of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedPodEphemeralcontainersRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodEphemeralcontainersRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodEphemeralcontainers(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPodLog** +> string readNamespacedPodLog() + +read log of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedPodLogRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodLogRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // The container for which to stream logs. Defaults to only container if there is one container in the pod. (optional) + container: "container_example", + // Follow the log stream of the pod. Defaults to false. (optional) + follow: true, + // insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). (optional) + insecureSkipTLSVerifyBackend: true, + // If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. (optional) + limitBytes: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // Return previous terminated container logs. Defaults to false. (optional) + previous: true, + // A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. (optional) + sinceSeconds: 1, + // Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) + stream: "stream_example", + // If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) + tailLines: 1, + // If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. (optional) + timestamps: true, +}; + +const data = await apiInstance.readNamespacedPodLog(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **container** | [**string**] | The container for which to stream logs. Defaults to only container if there is one container in the pod. | (optional) defaults to undefined + **follow** | [**boolean**] | Follow the log stream of the pod. Defaults to false. | (optional) defaults to undefined + **insecureSkipTLSVerifyBackend** | [**boolean**] | insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). | (optional) defaults to undefined + **limitBytes** | [**number**] | If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **previous** | [**boolean**] | Return previous terminated container logs. Defaults to false. | (optional) defaults to undefined + **sinceSeconds** | [**number**] | A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. | (optional) defaults to undefined + **stream** | [**string**] | Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined + **tailLines** | [**number**] | If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined + **timestamps** | [**boolean**] | If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. | (optional) defaults to undefined + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPodResize** +> V1Pod readNamespacedPodResize() + +read resize of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedPodResizeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodResizeRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodResize(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPodStatus** +> V1Pod readNamespacedPodStatus() + +read status of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedPodStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodStatusRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPodTemplate** +> V1PodTemplate readNamespacedPodTemplate() + +read the specified PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedPodTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1PodTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedReplicationController** +> V1ReplicationController readNamespacedReplicationController() + +read the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedReplicationControllerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ReplicationController** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedReplicationControllerScale** +> V1Scale readNamespacedReplicationControllerScale() + +read scale of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedReplicationControllerScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedReplicationControllerScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicationControllerScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedReplicationControllerStatus** +> V1ReplicationController readNamespacedReplicationControllerStatus() + +read status of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedReplicationControllerStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedReplicationControllerStatusRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicationControllerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ReplicationController** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceQuota** +> V1ResourceQuota readNamespacedResourceQuota() + +read the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedResourceQuotaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ResourceQuota** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceQuotaStatus** +> V1ResourceQuota readNamespacedResourceQuotaStatus() + +read status of the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedResourceQuotaStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedResourceQuotaStatusRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceQuotaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ResourceQuota** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedSecret** +> V1Secret readNamespacedSecret() + +read the specified Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedSecretRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Secret** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedService** +> V1Service readNamespacedService() + +read the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Service** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedServiceAccount** +> V1ServiceAccount readNamespacedServiceAccount() + +read the specified ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedServiceAccountRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ServiceAccount** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedServiceStatus** +> V1Service readNamespacedServiceStatus() + +read status of the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNamespacedServiceStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedServiceStatusRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Service** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNode** +> V1Node readNode() + +read the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNodeRequest = { + // name of the Node + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Node** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNodeStatus** +> V1Node readNodeStatus() + +read status of the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadNodeStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNodeStatusRequest = { + // name of the Node + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNodeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Node** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readPersistentVolume** +> V1PersistentVolume readPersistentVolume() + +read the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadPersistentVolumeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadPersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolume** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readPersistentVolumeStatus** +> V1PersistentVolume readPersistentVolumeStatus() + +read status of the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReadPersistentVolumeStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadPersistentVolumeStatusRequest = { + // name of the PersistentVolume + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPersistentVolumeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolume** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespace** +> V1Namespace replaceNamespace(body) + +replace the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespaceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespaceRequest = { + // name of the Namespace + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Namespace** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespaceFinalize** +> V1Namespace replaceNamespaceFinalize(body) + +replace finalize of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespaceFinalizeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespaceFinalizeRequest = { + // name of the Namespace + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.replaceNamespaceFinalize(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Namespace** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespaceStatus** +> V1Namespace replaceNamespaceStatus(body) + +replace status of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespaceStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespaceStatusRequest = { + // name of the Namespace + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespaceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Namespace** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedConfigMap** +> V1ConfigMap replaceNamespacedConfigMap(body) + +replace the specified ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedConfigMapRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + binaryData: { + "key": 'YQ==', + }, + data: { + "key": "key_example", + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ConfigMap**| | + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ConfigMap** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedEndpoints** +> V1Endpoints replaceNamespacedEndpoints(body) + +replace the specified Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedEndpointsRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + subsets: [ + { + addresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + notReadyAddresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Endpoints**| | + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Endpoints** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedEvent** +> CoreV1Event replaceNamespacedEvent(body) + +replace the specified Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + count: 1, + eventTime: "eventTime_example", + firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + involvedObject: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + kind: "kind_example", + lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + reason: "reason_example", + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingComponent: "reportingComponent_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + source: { + component: "component_example", + host: "host_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **CoreV1Event**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**CoreV1Event** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedLimitRange** +> V1LimitRange replaceNamespacedLimitRange(body) + +replace the specified LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedLimitRangeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + limits: [ + { + _default: { + "key": "key_example", + }, + defaultRequest: { + "key": "key_example", + }, + max: { + "key": "key_example", + }, + maxLimitRequestRatio: { + "key": "key_example", + }, + min: { + "key": "key_example", + }, + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1LimitRange**| | + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1LimitRange** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPersistentVolumeClaim** +> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaim(body) + +replace the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolumeClaim**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPersistentVolumeClaimStatus** +> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaimStatus(body) + +replace status of the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPersistentVolumeClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolumeClaim**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolumeClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPod** +> V1Pod replaceNamespacedPod(body) + +replace the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedPodRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPodEphemeralcontainers** +> V1Pod replaceNamespacedPodEphemeralcontainers(body) + +replace ephemeralcontainers of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodEphemeralcontainers(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPodResize** +> V1Pod replaceNamespacedPodResize(body) + +replace resize of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedPodResizeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodResizeRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodResize(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPodStatus** +> V1Pod replaceNamespacedPodStatus(body) + +replace status of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedPodStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodStatusRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPodTemplate** +> V1PodTemplate replaceNamespacedPodTemplate(body) + +replace the specified PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedPodTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodTemplate**| | + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PodTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedReplicationController** +> V1ReplicationController replaceNamespacedReplicationController(body) + +replace the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedReplicationControllerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + "key": "key_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicationController**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ReplicationController** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedReplicationControllerScale** +> V1Scale replaceNamespacedReplicationControllerScale(body) + +replace scale of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicationControllerScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Scale** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedReplicationControllerStatus** +> V1ReplicationController replaceNamespacedReplicationControllerStatus(body) + +replace status of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + "key": "key_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicationControllerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicationController**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ReplicationController** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceQuota** +> V1ResourceQuota replaceNamespacedResourceQuota(body) + +replace the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedResourceQuotaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + hard: { + "key": "key_example", + }, + scopeSelector: { + matchExpressions: [ + { + operator: "operator_example", + scopeName: "scopeName_example", + values: [ + "values_example", + ], + }, + ], + }, + scopes: [ + "scopes_example", + ], + }, + status: { + hard: { + "key": "key_example", + }, + used: { + "key": "key_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceQuota**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ResourceQuota** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceQuotaStatus** +> V1ResourceQuota replaceNamespacedResourceQuotaStatus(body) + +replace status of the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + hard: { + "key": "key_example", + }, + scopeSelector: { + matchExpressions: [ + { + operator: "operator_example", + scopeName: "scopeName_example", + values: [ + "values_example", + ], + }, + ], + }, + scopes: [ + "scopes_example", + ], + }, + status: { + hard: { + "key": "key_example", + }, + used: { + "key": "key_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceQuotaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceQuota**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ResourceQuota** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedSecret** +> V1Secret replaceNamespacedSecret(body) + +replace the specified Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedSecretRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: { + "key": 'YQ==', + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + stringData: { + "key": "key_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Secret**| | + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Secret** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedService** +> V1Service replaceNamespacedService(body) + +replace the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedServiceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allocateLoadBalancerNodePorts: true, + clusterIP: "clusterIP_example", + clusterIPs: [ + "clusterIPs_example", + ], + externalIPs: [ + "externalIPs_example", + ], + externalName: "externalName_example", + externalTrafficPolicy: "externalTrafficPolicy_example", + healthCheckNodePort: 1, + internalTrafficPolicy: "internalTrafficPolicy_example", + ipFamilies: [ + "ipFamilies_example", + ], + ipFamilyPolicy: "ipFamilyPolicy_example", + loadBalancerClass: "loadBalancerClass_example", + loadBalancerIP: "loadBalancerIP_example", + loadBalancerSourceRanges: [ + "loadBalancerSourceRanges_example", + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + nodePort: 1, + port: 1, + protocol: "protocol_example", + targetPort: "targetPort_example", + }, + ], + publishNotReadyAddresses: true, + selector: { + "key": "key_example", + }, + sessionAffinity: "sessionAffinity_example", + sessionAffinityConfig: { + clientIP: { + timeoutSeconds: 1, + }, + }, + trafficDistribution: "trafficDistribution_example", + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ipMode: "ipMode_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Service**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Service** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedServiceAccount** +> V1ServiceAccount replaceNamespacedServiceAccount(body) + +replace the specified ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedServiceAccountRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + automountServiceAccountToken: true, + imagePullSecrets: [ + { + name: "name_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + secrets: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceAccount**| | + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ServiceAccount** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedServiceStatus** +> V1Service replaceNamespacedServiceStatus(body) + +replace status of the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNamespacedServiceStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedServiceStatusRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allocateLoadBalancerNodePorts: true, + clusterIP: "clusterIP_example", + clusterIPs: [ + "clusterIPs_example", + ], + externalIPs: [ + "externalIPs_example", + ], + externalName: "externalName_example", + externalTrafficPolicy: "externalTrafficPolicy_example", + healthCheckNodePort: 1, + internalTrafficPolicy: "internalTrafficPolicy_example", + ipFamilies: [ + "ipFamilies_example", + ], + ipFamilyPolicy: "ipFamilyPolicy_example", + loadBalancerClass: "loadBalancerClass_example", + loadBalancerIP: "loadBalancerIP_example", + loadBalancerSourceRanges: [ + "loadBalancerSourceRanges_example", + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + nodePort: 1, + port: 1, + protocol: "protocol_example", + targetPort: "targetPort_example", + }, + ], + publishNotReadyAddresses: true, + selector: { + "key": "key_example", + }, + sessionAffinity: "sessionAffinity_example", + sessionAffinityConfig: { + clientIP: { + timeoutSeconds: 1, + }, + }, + trafficDistribution: "trafficDistribution_example", + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ipMode: "ipMode_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Service**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Service** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNode** +> V1Node replaceNode(body) + +replace the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNodeRequest = { + // name of the Node + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + configSource: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + externalID: "externalID_example", + podCIDR: "podCIDR_example", + podCIDRs: [ + "podCIDRs_example", + ], + providerID: "providerID_example", + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + unschedulable: true, + }, + status: { + addresses: [ + { + address: "address_example", + type: "type_example", + }, + ], + allocatable: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + config: { + active: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + assigned: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + error: "error_example", + lastKnownGood: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + }, + daemonEndpoints: { + kubeletEndpoint: { + Port: 1, + }, + }, + declaredFeatures: [ + "declaredFeatures_example", + ], + features: { + supplementalGroupsPolicy: true, + }, + images: [ + { + names: [ + "names_example", + ], + sizeBytes: 1, + }, + ], + nodeInfo: { + architecture: "architecture_example", + bootID: "bootID_example", + containerRuntimeVersion: "containerRuntimeVersion_example", + kernelVersion: "kernelVersion_example", + kubeProxyVersion: "kubeProxyVersion_example", + kubeletVersion: "kubeletVersion_example", + machineID: "machineID_example", + operatingSystem: "operatingSystem_example", + osImage: "osImage_example", + swap: { + capacity: 1, + }, + systemUUID: "systemUUID_example", + }, + phase: "phase_example", + runtimeHandlers: [ + { + features: { + recursiveReadOnlyMounts: true, + userNamespaces: true, + }, + name: "name_example", + }, + ], + volumesAttached: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumesInUse: [ + "volumesInUse_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Node**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Node** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNodeStatus** +> V1Node replaceNodeStatus(body) + +replace status of the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplaceNodeStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNodeStatusRequest = { + // name of the Node + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + configSource: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + externalID: "externalID_example", + podCIDR: "podCIDR_example", + podCIDRs: [ + "podCIDRs_example", + ], + providerID: "providerID_example", + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + unschedulable: true, + }, + status: { + addresses: [ + { + address: "address_example", + type: "type_example", + }, + ], + allocatable: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + config: { + active: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + assigned: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + error: "error_example", + lastKnownGood: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + }, + daemonEndpoints: { + kubeletEndpoint: { + Port: 1, + }, + }, + declaredFeatures: [ + "declaredFeatures_example", + ], + features: { + supplementalGroupsPolicy: true, + }, + images: [ + { + names: [ + "names_example", + ], + sizeBytes: 1, + }, + ], + nodeInfo: { + architecture: "architecture_example", + bootID: "bootID_example", + containerRuntimeVersion: "containerRuntimeVersion_example", + kernelVersion: "kernelVersion_example", + kubeProxyVersion: "kubeProxyVersion_example", + kubeletVersion: "kubeletVersion_example", + machineID: "machineID_example", + operatingSystem: "operatingSystem_example", + osImage: "osImage_example", + swap: { + capacity: 1, + }, + systemUUID: "systemUUID_example", + }, + phase: "phase_example", + runtimeHandlers: [ + { + features: { + recursiveReadOnlyMounts: true, + userNamespaces: true, + }, + name: "name_example", + }, + ], + volumesAttached: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumesInUse: [ + "volumesInUse_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNodeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Node**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Node** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replacePersistentVolume** +> V1PersistentVolume replacePersistentVolume(body) + +replace the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplacePersistentVolumeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplacePersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + status: { + lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + phase: "phase_example", + reason: "reason_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolume**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolume** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replacePersistentVolumeStatus** +> V1PersistentVolume replacePersistentVolumeStatus(body) + +replace status of the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from ''; +import type { CoreV1ApiReplacePersistentVolumeStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplacePersistentVolumeStatusRequest = { + // name of the PersistentVolume + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + status: { + lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + phase: "phase_example", + reason: "reason_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePersistentVolumeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolume**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PersistentVolume** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/CustomObjectsApi.md b/src/gen/docs/CustomObjectsApi.md new file mode 100644 index 0000000000..02f7241d62 --- /dev/null +++ b/src/gen/docs/CustomObjectsApi.md @@ -0,0 +1,2230 @@ +# .CustomObjectsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterCustomObject**](CustomObjectsApi.md#createClusterCustomObject) | **POST** /apis/{group}/{version}/{plural} | +[**createNamespacedCustomObject**](CustomObjectsApi.md#createNamespacedCustomObject) | **POST** /apis/{group}/{version}/namespaces/{namespace}/{plural} | +[**deleteClusterCustomObject**](CustomObjectsApi.md#deleteClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural}/{name} | +[**deleteCollectionClusterCustomObject**](CustomObjectsApi.md#deleteCollectionClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural} | +[**deleteCollectionNamespacedCustomObject**](CustomObjectsApi.md#deleteCollectionNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural} | +[**deleteNamespacedCustomObject**](CustomObjectsApi.md#deleteNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**getAPIResources**](CustomObjectsApi.md#getAPIResources) | **GET** /apis/{group}/{version} | +[**getClusterCustomObject**](CustomObjectsApi.md#getClusterCustomObject) | **GET** /apis/{group}/{version}/{plural}/{name} | +[**getClusterCustomObjectScale**](CustomObjectsApi.md#getClusterCustomObjectScale) | **GET** /apis/{group}/{version}/{plural}/{name}/scale | +[**getClusterCustomObjectStatus**](CustomObjectsApi.md#getClusterCustomObjectStatus) | **GET** /apis/{group}/{version}/{plural}/{name}/status | +[**getNamespacedCustomObject**](CustomObjectsApi.md#getNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**getNamespacedCustomObjectScale**](CustomObjectsApi.md#getNamespacedCustomObjectScale) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | +[**getNamespacedCustomObjectStatus**](CustomObjectsApi.md#getNamespacedCustomObjectStatus) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | +[**listClusterCustomObject**](CustomObjectsApi.md#listClusterCustomObject) | **GET** /apis/{group}/{version}/{plural} | +[**listCustomObjectForAllNamespaces**](CustomObjectsApi.md#listCustomObjectForAllNamespaces) | **GET** /apis/{group}/{version}/{resource_plural} | +[**listNamespacedCustomObject**](CustomObjectsApi.md#listNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural} | +[**patchClusterCustomObject**](CustomObjectsApi.md#patchClusterCustomObject) | **PATCH** /apis/{group}/{version}/{plural}/{name} | +[**patchClusterCustomObjectScale**](CustomObjectsApi.md#patchClusterCustomObjectScale) | **PATCH** /apis/{group}/{version}/{plural}/{name}/scale | +[**patchClusterCustomObjectStatus**](CustomObjectsApi.md#patchClusterCustomObjectStatus) | **PATCH** /apis/{group}/{version}/{plural}/{name}/status | +[**patchNamespacedCustomObject**](CustomObjectsApi.md#patchNamespacedCustomObject) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**patchNamespacedCustomObjectScale**](CustomObjectsApi.md#patchNamespacedCustomObjectScale) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | +[**patchNamespacedCustomObjectStatus**](CustomObjectsApi.md#patchNamespacedCustomObjectStatus) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | +[**replaceClusterCustomObject**](CustomObjectsApi.md#replaceClusterCustomObject) | **PUT** /apis/{group}/{version}/{plural}/{name} | +[**replaceClusterCustomObjectScale**](CustomObjectsApi.md#replaceClusterCustomObjectScale) | **PUT** /apis/{group}/{version}/{plural}/{name}/scale | +[**replaceClusterCustomObjectStatus**](CustomObjectsApi.md#replaceClusterCustomObjectStatus) | **PUT** /apis/{group}/{version}/{plural}/{name}/status | +[**replaceNamespacedCustomObject**](CustomObjectsApi.md#replaceNamespacedCustomObject) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**replaceNamespacedCustomObjectScale**](CustomObjectsApi.md#replaceNamespacedCustomObjectScale) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | +[**replaceNamespacedCustomObjectStatus**](CustomObjectsApi.md#replaceNamespacedCustomObjectStatus) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | + + +# **createClusterCustomObject** +> any createClusterCustomObject(body) + +Creates a cluster scoped Custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiCreateClusterCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiCreateClusterCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // The JSON schema of the Resource to create. + body: {}, + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to create. | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedCustomObject** +> any createNamespacedCustomObject(body) + +Creates a namespace scoped Custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiCreateNamespacedCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiCreateNamespacedCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // The JSON schema of the Resource to create. + body: {}, + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to create. | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteClusterCustomObject** +> any deleteClusterCustomObject() + +Deletes the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiDeleteClusterCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionClusterCustomObject** +> any deleteCollectionClusterCustomObject() + +Delete collection of cluster scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiDeleteCollectionClusterCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteCollectionClusterCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedCustomObject** +> any deleteCollectionNamespacedCustomObject() + +Delete collection of namespace scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedCustomObject** +> any deleteNamespacedCustomObject() + +Deletes the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiDeleteNamespacedCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiGetAPIResourcesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetAPIResourcesRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", +}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getClusterCustomObject** +> any getClusterCustomObject() + +Returns a cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiGetClusterCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A single Resource | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getClusterCustomObjectScale** +> any getClusterCustomObjectScale() + +read scale of the specified custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiGetClusterCustomObjectScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetClusterCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getClusterCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getClusterCustomObjectStatus** +> any getClusterCustomObjectStatus() + +read status of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiGetClusterCustomObjectStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetClusterCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getClusterCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getNamespacedCustomObject** +> any getNamespacedCustomObject() + +Returns a namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiGetNamespacedCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A single Resource | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getNamespacedCustomObjectScale** +> any getNamespacedCustomObjectScale() + +read scale of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiGetNamespacedCustomObjectScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetNamespacedCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getNamespacedCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getNamespacedCustomObjectStatus** +> any getNamespacedCustomObjectStatus() + +read status of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiGetNamespacedCustomObjectStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetNamespacedCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getNamespacedCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listClusterCustomObject** +> any listClusterCustomObject() + +list or watch cluster scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiListClusterCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiListClusterCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json;stream=watch + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listCustomObjectForAllNamespaces** +> any listCustomObjectForAllNamespaces() + +list or watch namespace scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiListCustomObjectForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiListCustomObjectForAllNamespacesRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + resourcePlural: "resource_plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) + watch: true, +}; + +const data = await apiInstance.listCustomObjectForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **resourcePlural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json;stream=watch + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedCustomObject** +> any listNamespacedCustomObject() + +list or watch namespace scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiListNamespacedCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiListNamespacedCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json;stream=watch + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchClusterCustomObject** +> any patchClusterCustomObject(body) + +patch the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiPatchClusterCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to patch. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to patch. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchClusterCustomObjectScale** +> any patchClusterCustomObjectScale(body) + +partially update scale of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiPatchClusterCustomObjectScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchClusterCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchClusterCustomObjectStatus** +> any patchClusterCustomObjectStatus(body) + +partially update status of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiPatchClusterCustomObjectStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchClusterCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedCustomObject** +> any patchNamespacedCustomObject(body) + +patch the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiPatchNamespacedCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to patch. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to patch. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedCustomObjectScale** +> any patchNamespacedCustomObjectScale(body) + +partially update scale of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiPatchNamespacedCustomObjectScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchNamespacedCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedCustomObjectStatus** +> any patchNamespacedCustomObjectStatus(body) + +partially update status of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiPatchNamespacedCustomObjectStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchNamespacedCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceClusterCustomObject** +> any replaceClusterCustomObject(body) + +replace the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiReplaceClusterCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to replace. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to replace. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceClusterCustomObjectScale** +> any replaceClusterCustomObjectScale(body) + +replace scale of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiReplaceClusterCustomObjectScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceClusterCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceClusterCustomObjectStatus** +> any replaceClusterCustomObjectStatus(body) + +replace status of the cluster scoped specified custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiReplaceClusterCustomObjectStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceClusterCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedCustomObject** +> any replaceNamespacedCustomObject(body) + +replace the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiReplaceNamespacedCustomObjectRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to replace. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to replace. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedCustomObjectScale** +> any replaceNamespacedCustomObjectScale(body) + +replace scale of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedCustomObjectStatus** +> any replaceNamespacedCustomObjectStatus(body) + +replace status of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from ''; +import type { CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + + +### Return type + +**any** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/DiscoveryApi.md b/src/gen/docs/DiscoveryApi.md new file mode 100644 index 0000000000..5f428cbcdd --- /dev/null +++ b/src/gen/docs/DiscoveryApi.md @@ -0,0 +1,57 @@ +# .DiscoveryApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](DiscoveryApi.md#getAPIGroup) | **GET** /apis/discovery.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, DiscoveryApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/DiscoveryV1Api.md b/src/gen/docs/DiscoveryV1Api.md new file mode 100644 index 0000000000..430db4b9f8 --- /dev/null +++ b/src/gen/docs/DiscoveryV1Api.md @@ -0,0 +1,908 @@ +# .DiscoveryV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedEndpointSlice**](DiscoveryV1Api.md#createNamespacedEndpointSlice) | **POST** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | +[**deleteCollectionNamespacedEndpointSlice**](DiscoveryV1Api.md#deleteCollectionNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | +[**deleteNamespacedEndpointSlice**](DiscoveryV1Api.md#deleteNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | +[**getAPIResources**](DiscoveryV1Api.md#getAPIResources) | **GET** /apis/discovery.k8s.io/v1/ | +[**listEndpointSliceForAllNamespaces**](DiscoveryV1Api.md#listEndpointSliceForAllNamespaces) | **GET** /apis/discovery.k8s.io/v1/endpointslices | +[**listNamespacedEndpointSlice**](DiscoveryV1Api.md#listNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | +[**patchNamespacedEndpointSlice**](DiscoveryV1Api.md#patchNamespacedEndpointSlice) | **PATCH** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | +[**readNamespacedEndpointSlice**](DiscoveryV1Api.md#readNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | +[**replaceNamespacedEndpointSlice**](DiscoveryV1Api.md#replaceNamespacedEndpointSlice) | **PUT** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | + + +# **createNamespacedEndpointSlice** +> V1EndpointSlice createNamespacedEndpointSlice(body) + +create an EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from ''; +import type { DiscoveryV1ApiCreateNamespacedEndpointSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiCreateNamespacedEndpointSliceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + addressType: "addressType_example", + apiVersion: "apiVersion_example", + endpoints: [ + { + addresses: [ + "addresses_example", + ], + conditions: { + ready: true, + serving: true, + terminating: true, + }, + deprecatedTopology: { + "key": "key_example", + }, + hints: { + forNodes: [ + { + name: "name_example", + }, + ], + forZones: [ + { + name: "name_example", + }, + ], + }, + hostname: "hostname_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + zone: "zone_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1EndpointSlice**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1EndpointSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedEndpointSlice** +> V1Status deleteCollectionNamespacedEndpointSlice() + +delete collection of EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from ''; +import type { DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedEndpointSlice** +> V1Status deleteNamespacedEndpointSlice() + +delete an EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from ''; +import type { DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listEndpointSliceForAllNamespaces** +> V1EndpointSliceList listEndpointSliceForAllNamespaces() + +list or watch objects of kind EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from ''; +import type { DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEndpointSliceForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1EndpointSliceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedEndpointSlice** +> V1EndpointSliceList listNamespacedEndpointSlice() + +list or watch objects of kind EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from ''; +import type { DiscoveryV1ApiListNamespacedEndpointSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiListNamespacedEndpointSliceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1EndpointSliceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedEndpointSlice** +> V1EndpointSlice patchNamespacedEndpointSlice(body) + +partially update the specified EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from ''; +import type { DiscoveryV1ApiPatchNamespacedEndpointSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiPatchNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1EndpointSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedEndpointSlice** +> V1EndpointSlice readNamespacedEndpointSlice() + +read the specified EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from ''; +import type { DiscoveryV1ApiReadNamespacedEndpointSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiReadNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1EndpointSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedEndpointSlice** +> V1EndpointSlice replaceNamespacedEndpointSlice(body) + +replace the specified EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from ''; +import type { DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + addressType: "addressType_example", + apiVersion: "apiVersion_example", + endpoints: [ + { + addresses: [ + "addresses_example", + ], + conditions: { + ready: true, + serving: true, + terminating: true, + }, + deprecatedTopology: { + "key": "key_example", + }, + hints: { + forNodes: [ + { + name: "name_example", + }, + ], + forZones: [ + { + name: "name_example", + }, + ], + }, + hostname: "hostname_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + zone: "zone_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1EndpointSlice**| | + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1EndpointSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/EventsApi.md b/src/gen/docs/EventsApi.md new file mode 100644 index 0000000000..c9a897d0f1 --- /dev/null +++ b/src/gen/docs/EventsApi.md @@ -0,0 +1,57 @@ +# .EventsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](EventsApi.md#getAPIGroup) | **GET** /apis/events.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, EventsApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new EventsApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/EventsV1Api.md b/src/gen/docs/EventsV1Api.md new file mode 100644 index 0000000000..a8a7c24508 --- /dev/null +++ b/src/gen/docs/EventsV1Api.md @@ -0,0 +1,884 @@ +# .EventsV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedEvent**](EventsV1Api.md#createNamespacedEvent) | **POST** /apis/events.k8s.io/v1/namespaces/{namespace}/events | +[**deleteCollectionNamespacedEvent**](EventsV1Api.md#deleteCollectionNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events | +[**deleteNamespacedEvent**](EventsV1Api.md#deleteNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | +[**getAPIResources**](EventsV1Api.md#getAPIResources) | **GET** /apis/events.k8s.io/v1/ | +[**listEventForAllNamespaces**](EventsV1Api.md#listEventForAllNamespaces) | **GET** /apis/events.k8s.io/v1/events | +[**listNamespacedEvent**](EventsV1Api.md#listNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events | +[**patchNamespacedEvent**](EventsV1Api.md#patchNamespacedEvent) | **PATCH** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | +[**readNamespacedEvent**](EventsV1Api.md#readNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | +[**replaceNamespacedEvent**](EventsV1Api.md#replaceNamespacedEvent) | **PUT** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | + + +# **createNamespacedEvent** +> EventsV1Event createNamespacedEvent(body) + +create an Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from ''; +import type { EventsV1ApiCreateNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiCreateNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + deprecatedCount: 1, + deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedSource: { + component: "component_example", + host: "host_example", + }, + eventTime: "eventTime_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + note: "note_example", + reason: "reason_example", + regarding: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingController: "reportingController_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **EventsV1Event**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**EventsV1Event** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedEvent** +> V1Status deleteCollectionNamespacedEvent() + +delete collection of Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from ''; +import type { EventsV1ApiDeleteCollectionNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiDeleteCollectionNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedEvent** +> V1Status deleteNamespacedEvent() + +delete an Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from ''; +import type { EventsV1ApiDeleteNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiDeleteNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listEventForAllNamespaces** +> EventsV1EventList listEventForAllNamespaces() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from ''; +import type { EventsV1ApiListEventForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiListEventForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEventForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**EventsV1EventList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedEvent** +> EventsV1EventList listNamespacedEvent() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from ''; +import type { EventsV1ApiListNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiListNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**EventsV1EventList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedEvent** +> EventsV1Event patchNamespacedEvent(body) + +partially update the specified Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from ''; +import type { EventsV1ApiPatchNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiPatchNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**EventsV1Event** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedEvent** +> EventsV1Event readNamespacedEvent() + +read the specified Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from ''; +import type { EventsV1ApiReadNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiReadNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**EventsV1Event** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedEvent** +> EventsV1Event replaceNamespacedEvent(body) + +replace the specified Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from ''; +import type { EventsV1ApiReplaceNamespacedEventRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiReplaceNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + deprecatedCount: 1, + deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedSource: { + component: "component_example", + host: "host_example", + }, + eventTime: "eventTime_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + note: "note_example", + reason: "reason_example", + regarding: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingController: "reportingController_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **EventsV1Event**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**EventsV1Event** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/FlowcontrolApiserverApi.md b/src/gen/docs/FlowcontrolApiserverApi.md new file mode 100644 index 0000000000..c08c9b10a5 --- /dev/null +++ b/src/gen/docs/FlowcontrolApiserverApi.md @@ -0,0 +1,57 @@ +# .FlowcontrolApiserverApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](FlowcontrolApiserverApi.md#getAPIGroup) | **GET** /apis/flowcontrol.apiserver.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/FlowcontrolApiserverV1Api.md b/src/gen/docs/FlowcontrolApiserverV1Api.md new file mode 100644 index 0000000000..4c71ac4ab5 --- /dev/null +++ b/src/gen/docs/FlowcontrolApiserverV1Api.md @@ -0,0 +1,2142 @@ +# .FlowcontrolApiserverV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createFlowSchema**](FlowcontrolApiserverV1Api.md#createFlowSchema) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | +[**createPriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#createPriorityLevelConfiguration) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | +[**deleteCollectionFlowSchema**](FlowcontrolApiserverV1Api.md#deleteCollectionFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | +[**deleteCollectionPriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#deleteCollectionPriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | +[**deleteFlowSchema**](FlowcontrolApiserverV1Api.md#deleteFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**deletePriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#deletePriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**getAPIResources**](FlowcontrolApiserverV1Api.md#getAPIResources) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/ | +[**listFlowSchema**](FlowcontrolApiserverV1Api.md#listFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | +[**listPriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#listPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | +[**patchFlowSchema**](FlowcontrolApiserverV1Api.md#patchFlowSchema) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**patchFlowSchemaStatus**](FlowcontrolApiserverV1Api.md#patchFlowSchemaStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | +[**patchPriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#patchPriorityLevelConfiguration) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**patchPriorityLevelConfigurationStatus**](FlowcontrolApiserverV1Api.md#patchPriorityLevelConfigurationStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | +[**readFlowSchema**](FlowcontrolApiserverV1Api.md#readFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**readFlowSchemaStatus**](FlowcontrolApiserverV1Api.md#readFlowSchemaStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | +[**readPriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#readPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**readPriorityLevelConfigurationStatus**](FlowcontrolApiserverV1Api.md#readPriorityLevelConfigurationStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | +[**replaceFlowSchema**](FlowcontrolApiserverV1Api.md#replaceFlowSchema) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**replaceFlowSchemaStatus**](FlowcontrolApiserverV1Api.md#replaceFlowSchemaStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | +[**replacePriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#replacePriorityLevelConfiguration) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**replacePriorityLevelConfigurationStatus**](FlowcontrolApiserverV1Api.md#replacePriorityLevelConfigurationStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | + + +# **createFlowSchema** +> V1FlowSchema createFlowSchema(body) + +create a FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiCreateFlowSchemaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiCreateFlowSchemaRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + distinguisherMethod: { + type: "type_example", + }, + matchingPrecedence: 1, + priorityLevelConfiguration: { + name: "name_example", + }, + rules: [ + { + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + clusterScope: true, + namespaces: [ + "namespaces_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + subjects: [ + { + group: { + name: "name_example", + }, + kind: "kind_example", + serviceAccount: { + name: "name_example", + namespace: "namespace_example", + }, + user: { + name: "name_example", + }, + }, + ], + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1FlowSchema**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1FlowSchema** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createPriorityLevelConfiguration** +> V1PriorityLevelConfiguration createPriorityLevelConfiguration(body) + +create a PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + exempt: { + lendablePercent: 1, + nominalConcurrencyShares: 1, + }, + limited: { + borrowingLimitPercent: 1, + lendablePercent: 1, + limitResponse: { + queuing: { + handSize: 1, + queueLengthLimit: 1, + queues: 1, + }, + type: "type_example", + }, + nominalConcurrencyShares: 1, + }, + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityLevelConfiguration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PriorityLevelConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionFlowSchema** +> V1Status deleteCollectionFlowSchema() + +delete collection of FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionPriorityLevelConfiguration** +> V1Status deleteCollectionPriorityLevelConfiguration() + +delete collection of PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteFlowSchema** +> V1Status deleteFlowSchema() + +delete a FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deletePriorityLevelConfiguration** +> V1Status deletePriorityLevelConfiguration() + +delete a PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deletePriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listFlowSchema** +> V1FlowSchemaList listFlowSchema() + +list or watch objects of kind FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiListFlowSchemaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiListFlowSchemaRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1FlowSchemaList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listPriorityLevelConfiguration** +> V1PriorityLevelConfigurationList listPriorityLevelConfiguration() + +list or watch objects of kind PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PriorityLevelConfigurationList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchFlowSchema** +> V1FlowSchema patchFlowSchema(body) + +partially update the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiPatchFlowSchemaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1FlowSchema** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchFlowSchemaStatus** +> V1FlowSchema patchFlowSchemaStatus(body) + +partially update status of the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest = { + // name of the FlowSchema + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchFlowSchemaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1FlowSchema** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchPriorityLevelConfiguration** +> V1PriorityLevelConfiguration patchPriorityLevelConfiguration(body) + +partially update the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1PriorityLevelConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchPriorityLevelConfigurationStatus** +> V1PriorityLevelConfiguration patchPriorityLevelConfigurationStatus(body) + +partially update status of the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPriorityLevelConfigurationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1PriorityLevelConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readFlowSchema** +> V1FlowSchema readFlowSchema() + +read the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiReadFlowSchemaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1FlowSchema** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readFlowSchemaStatus** +> V1FlowSchema readFlowSchemaStatus() + +read status of the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest = { + // name of the FlowSchema + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readFlowSchemaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1FlowSchema** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readPriorityLevelConfiguration** +> V1PriorityLevelConfiguration readPriorityLevelConfiguration() + +read the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1PriorityLevelConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readPriorityLevelConfigurationStatus** +> V1PriorityLevelConfiguration readPriorityLevelConfigurationStatus() + +read status of the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPriorityLevelConfigurationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1PriorityLevelConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceFlowSchema** +> V1FlowSchema replaceFlowSchema(body) + +replace the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + distinguisherMethod: { + type: "type_example", + }, + matchingPrecedence: 1, + priorityLevelConfiguration: { + name: "name_example", + }, + rules: [ + { + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + clusterScope: true, + namespaces: [ + "namespaces_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + subjects: [ + { + group: { + name: "name_example", + }, + kind: "kind_example", + serviceAccount: { + name: "name_example", + namespace: "namespace_example", + }, + user: { + name: "name_example", + }, + }, + ], + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1FlowSchema**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1FlowSchema** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceFlowSchemaStatus** +> V1FlowSchema replaceFlowSchemaStatus(body) + +replace status of the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest = { + // name of the FlowSchema + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + distinguisherMethod: { + type: "type_example", + }, + matchingPrecedence: 1, + priorityLevelConfiguration: { + name: "name_example", + }, + rules: [ + { + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + clusterScope: true, + namespaces: [ + "namespaces_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + subjects: [ + { + group: { + name: "name_example", + }, + kind: "kind_example", + serviceAccount: { + name: "name_example", + namespace: "namespace_example", + }, + user: { + name: "name_example", + }, + }, + ], + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceFlowSchemaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1FlowSchema**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1FlowSchema** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replacePriorityLevelConfiguration** +> V1PriorityLevelConfiguration replacePriorityLevelConfiguration(body) + +replace the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + exempt: { + lendablePercent: 1, + nominalConcurrencyShares: 1, + }, + limited: { + borrowingLimitPercent: 1, + lendablePercent: 1, + limitResponse: { + queuing: { + handSize: 1, + queueLengthLimit: 1, + queues: 1, + }, + type: "type_example", + }, + nominalConcurrencyShares: 1, + }, + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityLevelConfiguration**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PriorityLevelConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replacePriorityLevelConfigurationStatus** +> V1PriorityLevelConfiguration replacePriorityLevelConfigurationStatus(body) + +replace status of the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from ''; +import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + exempt: { + lendablePercent: 1, + nominalConcurrencyShares: 1, + }, + limited: { + borrowingLimitPercent: 1, + lendablePercent: 1, + limitResponse: { + queuing: { + handSize: 1, + queueLengthLimit: 1, + queues: 1, + }, + type: "type_example", + }, + nominalConcurrencyShares: 1, + }, + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePriorityLevelConfigurationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityLevelConfiguration**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PriorityLevelConfiguration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/InternalApiserverApi.md b/src/gen/docs/InternalApiserverApi.md new file mode 100644 index 0000000000..def720c026 --- /dev/null +++ b/src/gen/docs/InternalApiserverApi.md @@ -0,0 +1,57 @@ +# .InternalApiserverApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](InternalApiserverApi.md#getAPIGroup) | **GET** /apis/internal.apiserver.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, InternalApiserverApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/InternalApiserverV1alpha1Api.md b/src/gen/docs/InternalApiserverV1alpha1Api.md new file mode 100644 index 0000000000..0f20d915c2 --- /dev/null +++ b/src/gen/docs/InternalApiserverV1alpha1Api.md @@ -0,0 +1,1032 @@ +# .InternalApiserverV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createStorageVersion**](InternalApiserverV1alpha1Api.md#createStorageVersion) | **POST** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | +[**deleteCollectionStorageVersion**](InternalApiserverV1alpha1Api.md#deleteCollectionStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | +[**deleteStorageVersion**](InternalApiserverV1alpha1Api.md#deleteStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**getAPIResources**](InternalApiserverV1alpha1Api.md#getAPIResources) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/ | +[**listStorageVersion**](InternalApiserverV1alpha1Api.md#listStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | +[**patchStorageVersion**](InternalApiserverV1alpha1Api.md#patchStorageVersion) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**patchStorageVersionStatus**](InternalApiserverV1alpha1Api.md#patchStorageVersionStatus) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | +[**readStorageVersion**](InternalApiserverV1alpha1Api.md#readStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**readStorageVersionStatus**](InternalApiserverV1alpha1Api.md#readStorageVersionStatus) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | +[**replaceStorageVersion**](InternalApiserverV1alpha1Api.md#replaceStorageVersion) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**replaceStorageVersionStatus**](InternalApiserverV1alpha1Api.md#replaceStorageVersionStatus) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | + + +# **createStorageVersion** +> V1alpha1StorageVersion createStorageVersion(body) + +create a StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; +import type { InternalApiserverV1alpha1ApiCreateStorageVersionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiCreateStorageVersionRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: {}, + status: { + commonEncodingVersion: "commonEncodingVersion_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + storageVersions: [ + { + apiServerID: "apiServerID_example", + decodableVersions: [ + "decodableVersions_example", + ], + encodingVersion: "encodingVersion_example", + servedVersions: [ + "servedVersions_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1StorageVersion**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1StorageVersion** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionStorageVersion** +> V1Status deleteCollectionStorageVersion() + +delete collection of StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; +import type { InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteStorageVersion** +> V1Status deleteStorageVersion() + +delete a StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; +import type { InternalApiserverV1alpha1ApiDeleteStorageVersionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiDeleteStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listStorageVersion** +> V1alpha1StorageVersionList listStorageVersion() + +list or watch objects of kind StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; +import type { InternalApiserverV1alpha1ApiListStorageVersionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiListStorageVersionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1alpha1StorageVersionList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchStorageVersion** +> V1alpha1StorageVersion patchStorageVersion(body) + +partially update the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; +import type { InternalApiserverV1alpha1ApiPatchStorageVersionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiPatchStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1alpha1StorageVersion** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchStorageVersionStatus** +> V1alpha1StorageVersion patchStorageVersionStatus(body) + +partially update status of the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; +import type { InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest = { + // name of the StorageVersion + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1alpha1StorageVersion** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readStorageVersion** +> V1alpha1StorageVersion readStorageVersion() + +read the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; +import type { InternalApiserverV1alpha1ApiReadStorageVersionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReadStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1alpha1StorageVersion** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readStorageVersionStatus** +> V1alpha1StorageVersion readStorageVersionStatus() + +read status of the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; +import type { InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest = { + // name of the StorageVersion + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1alpha1StorageVersion** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceStorageVersion** +> V1alpha1StorageVersion replaceStorageVersion(body) + +replace the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; +import type { InternalApiserverV1alpha1ApiReplaceStorageVersionRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReplaceStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: {}, + status: { + commonEncodingVersion: "commonEncodingVersion_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + storageVersions: [ + { + apiServerID: "apiServerID_example", + decodableVersions: [ + "decodableVersions_example", + ], + encodingVersion: "encodingVersion_example", + servedVersions: [ + "servedVersions_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1StorageVersion**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1StorageVersion** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceStorageVersionStatus** +> V1alpha1StorageVersion replaceStorageVersionStatus(body) + +replace status of the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from ''; +import type { InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest = { + // name of the StorageVersion + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: {}, + status: { + commonEncodingVersion: "commonEncodingVersion_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + storageVersions: [ + { + apiServerID: "apiServerID_example", + decodableVersions: [ + "decodableVersions_example", + ], + encodingVersion: "encodingVersion_example", + servedVersions: [ + "servedVersions_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1StorageVersion**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1StorageVersion** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/LogsApi.md b/src/gen/docs/LogsApi.md new file mode 100644 index 0000000000..902d0f8c60 --- /dev/null +++ b/src/gen/docs/LogsApi.md @@ -0,0 +1,108 @@ +# .LogsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**logFileHandler**](LogsApi.md#logFileHandler) | **GET** /logs/{logpath} | +[**logFileListHandler**](LogsApi.md#logFileListHandler) | **GET** /logs/ | + + +# **logFileHandler** +> logFileHandler() + + +### Example + + +```typescript +import { createConfiguration, LogsApi } from ''; +import type { LogsApiLogFileHandlerRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new LogsApi(configuration); + +const request: LogsApiLogFileHandlerRequest = { + // path to the log + logpath: "logpath_example", +}; + +const data = await apiInstance.logFileHandler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **logpath** | [**string**] | path to the log | defaults to undefined + + +### Return type + +void (empty response body) + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **logFileListHandler** +> logFileListHandler() + + +### Example + + +```typescript +import { createConfiguration, LogsApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new LogsApi(configuration); + +const request = {}; + +const data = await apiInstance.logFileListHandler(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +void (empty response body) + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/NetworkingApi.md b/src/gen/docs/NetworkingApi.md new file mode 100644 index 0000000000..b1832f1a30 --- /dev/null +++ b/src/gen/docs/NetworkingApi.md @@ -0,0 +1,57 @@ +# .NetworkingApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](NetworkingApi.md#getAPIGroup) | **GET** /apis/networking.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, NetworkingApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/NetworkingV1Api.md b/src/gen/docs/NetworkingV1Api.md new file mode 100644 index 0000000000..abcdc5d918 --- /dev/null +++ b/src/gen/docs/NetworkingV1Api.md @@ -0,0 +1,4547 @@ +# .NetworkingV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createIPAddress**](NetworkingV1Api.md#createIPAddress) | **POST** /apis/networking.k8s.io/v1/ipaddresses | +[**createIngressClass**](NetworkingV1Api.md#createIngressClass) | **POST** /apis/networking.k8s.io/v1/ingressclasses | +[**createNamespacedIngress**](NetworkingV1Api.md#createNamespacedIngress) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | +[**createNamespacedNetworkPolicy**](NetworkingV1Api.md#createNamespacedNetworkPolicy) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | +[**createServiceCIDR**](NetworkingV1Api.md#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1/servicecidrs | +[**deleteCollectionIPAddress**](NetworkingV1Api.md#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses | +[**deleteCollectionIngressClass**](NetworkingV1Api.md#deleteCollectionIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses | +[**deleteCollectionNamespacedIngress**](NetworkingV1Api.md#deleteCollectionNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | +[**deleteCollectionNamespacedNetworkPolicy**](NetworkingV1Api.md#deleteCollectionNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | +[**deleteCollectionServiceCIDR**](NetworkingV1Api.md#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs | +[**deleteIPAddress**](NetworkingV1Api.md#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**deleteIngressClass**](NetworkingV1Api.md#deleteIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**deleteNamespacedIngress**](NetworkingV1Api.md#deleteNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**deleteNamespacedNetworkPolicy**](NetworkingV1Api.md#deleteNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**deleteServiceCIDR**](NetworkingV1Api.md#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**getAPIResources**](NetworkingV1Api.md#getAPIResources) | **GET** /apis/networking.k8s.io/v1/ | +[**listIPAddress**](NetworkingV1Api.md#listIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses | +[**listIngressClass**](NetworkingV1Api.md#listIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses | +[**listIngressForAllNamespaces**](NetworkingV1Api.md#listIngressForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/ingresses | +[**listNamespacedIngress**](NetworkingV1Api.md#listNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | +[**listNamespacedNetworkPolicy**](NetworkingV1Api.md#listNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | +[**listNetworkPolicyForAllNamespaces**](NetworkingV1Api.md#listNetworkPolicyForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/networkpolicies | +[**listServiceCIDR**](NetworkingV1Api.md#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs | +[**patchIPAddress**](NetworkingV1Api.md#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**patchIngressClass**](NetworkingV1Api.md#patchIngressClass) | **PATCH** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**patchNamespacedIngress**](NetworkingV1Api.md#patchNamespacedIngress) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**patchNamespacedIngressStatus**](NetworkingV1Api.md#patchNamespacedIngressStatus) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | +[**patchNamespacedNetworkPolicy**](NetworkingV1Api.md#patchNamespacedNetworkPolicy) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**patchServiceCIDR**](NetworkingV1Api.md#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**patchServiceCIDRStatus**](NetworkingV1Api.md#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | +[**readIPAddress**](NetworkingV1Api.md#readIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**readIngressClass**](NetworkingV1Api.md#readIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**readNamespacedIngress**](NetworkingV1Api.md#readNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**readNamespacedIngressStatus**](NetworkingV1Api.md#readNamespacedIngressStatus) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | +[**readNamespacedNetworkPolicy**](NetworkingV1Api.md#readNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**readServiceCIDR**](NetworkingV1Api.md#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**readServiceCIDRStatus**](NetworkingV1Api.md#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | +[**replaceIPAddress**](NetworkingV1Api.md#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**replaceIngressClass**](NetworkingV1Api.md#replaceIngressClass) | **PUT** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**replaceNamespacedIngress**](NetworkingV1Api.md#replaceNamespacedIngress) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**replaceNamespacedIngressStatus**](NetworkingV1Api.md#replaceNamespacedIngressStatus) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | +[**replaceNamespacedNetworkPolicy**](NetworkingV1Api.md#replaceNamespacedNetworkPolicy) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**replaceServiceCIDR**](NetworkingV1Api.md#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**replaceServiceCIDRStatus**](NetworkingV1Api.md#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | + + +# **createIPAddress** +> V1IPAddress createIPAddress(body) + +create an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiCreateIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateIPAddressRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IPAddress**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1IPAddress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createIngressClass** +> V1IngressClass createIngressClass(body) + +create an IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiCreateIngressClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateIngressClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controller: "controller_example", + parameters: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + scope: "scope_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IngressClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1IngressClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedIngress** +> V1Ingress createNamespacedIngress(body) + +create an Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiCreateNamespacedIngressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateNamespacedIngressRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + defaultBackend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + ingressClassName: "ingressClassName_example", + rules: [ + { + host: "host_example", + http: { + paths: [ + { + backend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + path: "path_example", + pathType: "pathType_example", + }, + ], + }, + }, + ], + tls: [ + { + hosts: [ + "hosts_example", + ], + secretName: "secretName_example", + }, + ], + }, + status: { + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Ingress**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Ingress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedNetworkPolicy** +> V1NetworkPolicy createNamespacedNetworkPolicy(body) + +create a NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiCreateNamespacedNetworkPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateNamespacedNetworkPolicyRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + egress: [ + { + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + to: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + }, + ], + ingress: [ + { + _from: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + }, + ], + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + policyTypes: [ + "policyTypes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1NetworkPolicy**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1NetworkPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createServiceCIDR** +> V1ServiceCIDR createServiceCIDR(body) + +create a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiCreateServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateServiceCIDRRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceCIDR**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionIPAddress** +> V1Status deleteCollectionIPAddress() + +delete collection of IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiDeleteCollectionIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionIngressClass** +> V1Status deleteCollectionIngressClass() + +delete collection of IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiDeleteCollectionIngressClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionIngressClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedIngress** +> V1Status deleteCollectionNamespacedIngress() + +delete collection of Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiDeleteCollectionNamespacedIngressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionNamespacedIngressRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedNetworkPolicy** +> V1Status deleteCollectionNamespacedNetworkPolicy() + +delete collection of NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionServiceCIDR** +> V1Status deleteCollectionServiceCIDR() + +delete collection of ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiDeleteCollectionServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteIPAddress** +> V1Status deleteIPAddress() + +delete an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiDeleteIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteIngressClass** +> V1Status deleteIngressClass() + +delete an IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiDeleteIngressClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteIngressClassRequest = { + // name of the IngressClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedIngress** +> V1Status deleteNamespacedIngress() + +delete an Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiDeleteNamespacedIngressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedNetworkPolicy** +> V1Status deleteNamespacedNetworkPolicy() + +delete a NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteServiceCIDR** +> V1Status deleteServiceCIDR() + +delete a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiDeleteServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listIPAddress** +> V1IPAddressList listIPAddress() + +list or watch objects of kind IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiListIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1IPAddressList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listIngressClass** +> V1IngressClassList listIngressClass() + +list or watch objects of kind IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiListIngressClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListIngressClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1IngressClassList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listIngressForAllNamespaces** +> V1IngressList listIngressForAllNamespaces() + +list or watch objects of kind Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiListIngressForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListIngressForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIngressForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1IngressList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedIngress** +> V1IngressList listNamespacedIngress() + +list or watch objects of kind Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiListNamespacedIngressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListNamespacedIngressRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1IngressList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedNetworkPolicy** +> V1NetworkPolicyList listNamespacedNetworkPolicy() + +list or watch objects of kind NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiListNamespacedNetworkPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListNamespacedNetworkPolicyRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1NetworkPolicyList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNetworkPolicyForAllNamespaces** +> V1NetworkPolicyList listNetworkPolicyForAllNamespaces() + +list or watch objects of kind NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNetworkPolicyForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1NetworkPolicyList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listServiceCIDR** +> V1ServiceCIDRList listServiceCIDR() + +list or watch objects of kind ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiListServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ServiceCIDRList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchIPAddress** +> V1IPAddress patchIPAddress(body) + +partially update the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiPatchIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1IPAddress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchIngressClass** +> V1IngressClass patchIngressClass(body) + +partially update the specified IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiPatchIngressClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchIngressClassRequest = { + // name of the IngressClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1IngressClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedIngress** +> V1Ingress patchNamespacedIngress(body) + +partially update the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiPatchNamespacedIngressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Ingress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedIngressStatus** +> V1Ingress patchNamespacedIngressStatus(body) + +partially update status of the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiPatchNamespacedIngressStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchNamespacedIngressStatusRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedIngressStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Ingress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedNetworkPolicy** +> V1NetworkPolicy patchNamespacedNetworkPolicy(body) + +partially update the specified NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiPatchNamespacedNetworkPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1NetworkPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchServiceCIDR** +> V1ServiceCIDR patchServiceCIDR(body) + +partially update the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiPatchServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchServiceCIDRStatus** +> V1ServiceCIDR patchServiceCIDRStatus(body) + +partially update status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiPatchServiceCIDRStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readIPAddress** +> V1IPAddress readIPAddress() + +read the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReadIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1IPAddress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readIngressClass** +> V1IngressClass readIngressClass() + +read the specified IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReadIngressClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadIngressClassRequest = { + // name of the IngressClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1IngressClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedIngress** +> V1Ingress readNamespacedIngress() + +read the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReadNamespacedIngressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Ingress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedIngressStatus** +> V1Ingress readNamespacedIngressStatus() + +read status of the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReadNamespacedIngressStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadNamespacedIngressStatusRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedIngressStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Ingress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedNetworkPolicy** +> V1NetworkPolicy readNamespacedNetworkPolicy() + +read the specified NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReadNamespacedNetworkPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1NetworkPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readServiceCIDR** +> V1ServiceCIDR readServiceCIDR() + +read the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReadServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readServiceCIDRStatus** +> V1ServiceCIDR readServiceCIDRStatus() + +read status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReadServiceCIDRStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceIPAddress** +> V1IPAddress replaceIPAddress(body) + +replace the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReplaceIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IPAddress**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1IPAddress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceIngressClass** +> V1IngressClass replaceIngressClass(body) + +replace the specified IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReplaceIngressClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceIngressClassRequest = { + // name of the IngressClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controller: "controller_example", + parameters: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + scope: "scope_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IngressClass**| | + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1IngressClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedIngress** +> V1Ingress replaceNamespacedIngress(body) + +replace the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReplaceNamespacedIngressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + defaultBackend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + ingressClassName: "ingressClassName_example", + rules: [ + { + host: "host_example", + http: { + paths: [ + { + backend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + path: "path_example", + pathType: "pathType_example", + }, + ], + }, + }, + ], + tls: [ + { + hosts: [ + "hosts_example", + ], + secretName: "secretName_example", + }, + ], + }, + status: { + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Ingress**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Ingress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedIngressStatus** +> V1Ingress replaceNamespacedIngressStatus(body) + +replace status of the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReplaceNamespacedIngressStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceNamespacedIngressStatusRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + defaultBackend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + ingressClassName: "ingressClassName_example", + rules: [ + { + host: "host_example", + http: { + paths: [ + { + backend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + path: "path_example", + pathType: "pathType_example", + }, + ], + }, + }, + ], + tls: [ + { + hosts: [ + "hosts_example", + ], + secretName: "secretName_example", + }, + ], + }, + status: { + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedIngressStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Ingress**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Ingress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedNetworkPolicy** +> V1NetworkPolicy replaceNamespacedNetworkPolicy(body) + +replace the specified NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + egress: [ + { + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + to: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + }, + ], + ingress: [ + { + _from: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + }, + ], + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + policyTypes: [ + "policyTypes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1NetworkPolicy**| | + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1NetworkPolicy** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceServiceCIDR** +> V1ServiceCIDR replaceServiceCIDR(body) + +replace the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReplaceServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceServiceCIDRStatus** +> V1ServiceCIDR replaceServiceCIDRStatus(body) + +replace status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from ''; +import type { NetworkingV1ApiReplaceServiceCIDRStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/NetworkingV1beta1Api.md b/src/gen/docs/NetworkingV1beta1Api.md new file mode 100644 index 0000000000..5157414b61 --- /dev/null +++ b/src/gen/docs/NetworkingV1beta1Api.md @@ -0,0 +1,1670 @@ +# .NetworkingV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createIPAddress**](NetworkingV1beta1Api.md#createIPAddress) | **POST** /apis/networking.k8s.io/v1beta1/ipaddresses | +[**createServiceCIDR**](NetworkingV1beta1Api.md#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1beta1/servicecidrs | +[**deleteCollectionIPAddress**](NetworkingV1beta1Api.md#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses | +[**deleteCollectionServiceCIDR**](NetworkingV1beta1Api.md#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs | +[**deleteIPAddress**](NetworkingV1beta1Api.md#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**deleteServiceCIDR**](NetworkingV1beta1Api.md#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**getAPIResources**](NetworkingV1beta1Api.md#getAPIResources) | **GET** /apis/networking.k8s.io/v1beta1/ | +[**listIPAddress**](NetworkingV1beta1Api.md#listIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses | +[**listServiceCIDR**](NetworkingV1beta1Api.md#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs | +[**patchIPAddress**](NetworkingV1beta1Api.md#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**patchServiceCIDR**](NetworkingV1beta1Api.md#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**patchServiceCIDRStatus**](NetworkingV1beta1Api.md#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | +[**readIPAddress**](NetworkingV1beta1Api.md#readIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**readServiceCIDR**](NetworkingV1beta1Api.md#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**readServiceCIDRStatus**](NetworkingV1beta1Api.md#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | +[**replaceIPAddress**](NetworkingV1beta1Api.md#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**replaceServiceCIDR**](NetworkingV1beta1Api.md#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**replaceServiceCIDRStatus**](NetworkingV1beta1Api.md#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | + + +# **createIPAddress** +> V1beta1IPAddress createIPAddress(body) + +create an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiCreateIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiCreateIPAddressRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1IPAddress**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1IPAddress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createServiceCIDR** +> V1beta1ServiceCIDR createServiceCIDR(body) + +create a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiCreateServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiCreateServiceCIDRRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ServiceCIDR**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionIPAddress** +> V1Status deleteCollectionIPAddress() + +delete collection of IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiDeleteCollectionIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteCollectionIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionServiceCIDR** +> V1Status deleteCollectionServiceCIDR() + +delete collection of ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteIPAddress** +> V1Status deleteIPAddress() + +delete an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiDeleteIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteServiceCIDR** +> V1Status deleteServiceCIDR() + +delete a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiDeleteServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listIPAddress** +> V1beta1IPAddressList listIPAddress() + +list or watch objects of kind IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiListIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiListIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1IPAddressList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listServiceCIDR** +> V1beta1ServiceCIDRList listServiceCIDR() + +list or watch objects of kind ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiListServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiListServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1ServiceCIDRList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchIPAddress** +> V1beta1IPAddress patchIPAddress(body) + +partially update the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiPatchIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiPatchIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1IPAddress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchServiceCIDR** +> V1beta1ServiceCIDR patchServiceCIDR(body) + +partially update the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiPatchServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiPatchServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchServiceCIDRStatus** +> V1beta1ServiceCIDR patchServiceCIDRStatus(body) + +partially update status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiPatchServiceCIDRStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiPatchServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readIPAddress** +> V1beta1IPAddress readIPAddress() + +read the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiReadIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReadIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1IPAddress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readServiceCIDR** +> V1beta1ServiceCIDR readServiceCIDR() + +read the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiReadServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReadServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readServiceCIDRStatus** +> V1beta1ServiceCIDR readServiceCIDRStatus() + +read status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiReadServiceCIDRStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReadServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceIPAddress** +> V1beta1IPAddress replaceIPAddress(body) + +replace the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiReplaceIPAddressRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReplaceIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1IPAddress**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1IPAddress** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceServiceCIDR** +> V1beta1ServiceCIDR replaceServiceCIDR(body) + +replace the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiReplaceServiceCIDRRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReplaceServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceServiceCIDRStatus** +> V1beta1ServiceCIDR replaceServiceCIDRStatus(body) + +replace status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from ''; +import type { NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ServiceCIDR** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/NodeApi.md b/src/gen/docs/NodeApi.md new file mode 100644 index 0000000000..a5acdcc5cf --- /dev/null +++ b/src/gen/docs/NodeApi.md @@ -0,0 +1,57 @@ +# .NodeApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](NodeApi.md#getAPIGroup) | **GET** /apis/node.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, NodeApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NodeApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/NodeV1Api.md b/src/gen/docs/NodeV1Api.md new file mode 100644 index 0000000000..cfd84365e1 --- /dev/null +++ b/src/gen/docs/NodeV1Api.md @@ -0,0 +1,746 @@ +# .NodeV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createRuntimeClass**](NodeV1Api.md#createRuntimeClass) | **POST** /apis/node.k8s.io/v1/runtimeclasses | +[**deleteCollectionRuntimeClass**](NodeV1Api.md#deleteCollectionRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses | +[**deleteRuntimeClass**](NodeV1Api.md#deleteRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses/{name} | +[**getAPIResources**](NodeV1Api.md#getAPIResources) | **GET** /apis/node.k8s.io/v1/ | +[**listRuntimeClass**](NodeV1Api.md#listRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses | +[**patchRuntimeClass**](NodeV1Api.md#patchRuntimeClass) | **PATCH** /apis/node.k8s.io/v1/runtimeclasses/{name} | +[**readRuntimeClass**](NodeV1Api.md#readRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses/{name} | +[**replaceRuntimeClass**](NodeV1Api.md#replaceRuntimeClass) | **PUT** /apis/node.k8s.io/v1/runtimeclasses/{name} | + + +# **createRuntimeClass** +> V1RuntimeClass createRuntimeClass(body) + +create a RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from ''; +import type { NodeV1ApiCreateRuntimeClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiCreateRuntimeClassRequest = { + + body: { + apiVersion: "apiVersion_example", + handler: "handler_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + overhead: { + podFixed: { + "key": "key_example", + }, + }, + scheduling: { + nodeSelector: { + "key": "key_example", + }, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RuntimeClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1RuntimeClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionRuntimeClass** +> V1Status deleteCollectionRuntimeClass() + +delete collection of RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from ''; +import type { NodeV1ApiDeleteCollectionRuntimeClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiDeleteCollectionRuntimeClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteRuntimeClass** +> V1Status deleteRuntimeClass() + +delete a RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from ''; +import type { NodeV1ApiDeleteRuntimeClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiDeleteRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listRuntimeClass** +> V1RuntimeClassList listRuntimeClass() + +list or watch objects of kind RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from ''; +import type { NodeV1ApiListRuntimeClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiListRuntimeClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1RuntimeClassList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchRuntimeClass** +> V1RuntimeClass patchRuntimeClass(body) + +partially update the specified RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from ''; +import type { NodeV1ApiPatchRuntimeClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiPatchRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1RuntimeClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readRuntimeClass** +> V1RuntimeClass readRuntimeClass() + +read the specified RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from ''; +import type { NodeV1ApiReadRuntimeClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiReadRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1RuntimeClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceRuntimeClass** +> V1RuntimeClass replaceRuntimeClass(body) + +replace the specified RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from ''; +import type { NodeV1ApiReplaceRuntimeClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiReplaceRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + handler: "handler_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + overhead: { + podFixed: { + "key": "key_example", + }, + }, + scheduling: { + nodeSelector: { + "key": "key_example", + }, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RuntimeClass**| | + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1RuntimeClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/OpenidApi.md b/src/gen/docs/OpenidApi.md new file mode 100644 index 0000000000..a9714d17a5 --- /dev/null +++ b/src/gen/docs/OpenidApi.md @@ -0,0 +1,57 @@ +# .OpenidApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getServiceAccountIssuerOpenIDKeyset**](OpenidApi.md#getServiceAccountIssuerOpenIDKeyset) | **GET** /openid/v1/jwks | + + +# **getServiceAccountIssuerOpenIDKeyset** +> string getServiceAccountIssuerOpenIDKeyset() + +get service account issuer OpenID JSON Web Key Set (contains public token verification keys) + +### Example + + +```typescript +import { createConfiguration, OpenidApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new OpenidApi(configuration); + +const request = {}; + +const data = await apiInstance.getServiceAccountIssuerOpenIDKeyset(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/jwk-set+json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/PolicyApi.md b/src/gen/docs/PolicyApi.md new file mode 100644 index 0000000000..0820843253 --- /dev/null +++ b/src/gen/docs/PolicyApi.md @@ -0,0 +1,57 @@ +# .PolicyApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](PolicyApi.md#getAPIGroup) | **GET** /apis/policy/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, PolicyApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/PolicyV1Api.md b/src/gen/docs/PolicyV1Api.md new file mode 100644 index 0000000000..732f6b89ea --- /dev/null +++ b/src/gen/docs/PolicyV1Api.md @@ -0,0 +1,1186 @@ +# .PolicyV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedPodDisruptionBudget**](PolicyV1Api.md#createNamespacedPodDisruptionBudget) | **POST** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | +[**deleteCollectionNamespacedPodDisruptionBudget**](PolicyV1Api.md#deleteCollectionNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | +[**deleteNamespacedPodDisruptionBudget**](PolicyV1Api.md#deleteNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**getAPIResources**](PolicyV1Api.md#getAPIResources) | **GET** /apis/policy/v1/ | +[**listNamespacedPodDisruptionBudget**](PolicyV1Api.md#listNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | +[**listPodDisruptionBudgetForAllNamespaces**](PolicyV1Api.md#listPodDisruptionBudgetForAllNamespaces) | **GET** /apis/policy/v1/poddisruptionbudgets | +[**patchNamespacedPodDisruptionBudget**](PolicyV1Api.md#patchNamespacedPodDisruptionBudget) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**patchNamespacedPodDisruptionBudgetStatus**](PolicyV1Api.md#patchNamespacedPodDisruptionBudgetStatus) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | +[**readNamespacedPodDisruptionBudget**](PolicyV1Api.md#readNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**readNamespacedPodDisruptionBudgetStatus**](PolicyV1Api.md#readNamespacedPodDisruptionBudgetStatus) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | +[**replaceNamespacedPodDisruptionBudget**](PolicyV1Api.md#replaceNamespacedPodDisruptionBudget) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**replaceNamespacedPodDisruptionBudgetStatus**](PolicyV1Api.md#replaceNamespacedPodDisruptionBudgetStatus) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | + + +# **createNamespacedPodDisruptionBudget** +> V1PodDisruptionBudget createNamespacedPodDisruptionBudget(body) + +create a PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxUnavailable: "maxUnavailable_example", + minAvailable: "minAvailable_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentHealthy: 1, + desiredHealthy: 1, + disruptedPods: { + "key": new Date('1970-01-01T00:00:00.00Z'), + }, + disruptionsAllowed: 1, + expectedPods: 1, + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodDisruptionBudget**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PodDisruptionBudget** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedPodDisruptionBudget** +> V1Status deleteCollectionNamespacedPodDisruptionBudget() + +delete collection of PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedPodDisruptionBudget** +> V1Status deleteNamespacedPodDisruptionBudget() + +delete a PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedPodDisruptionBudget** +> V1PodDisruptionBudgetList listNamespacedPodDisruptionBudget() + +list or watch objects of kind PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiListNamespacedPodDisruptionBudgetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiListNamespacedPodDisruptionBudgetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PodDisruptionBudgetList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listPodDisruptionBudgetForAllNamespaces** +> V1PodDisruptionBudgetList listPodDisruptionBudgetForAllNamespaces() + +list or watch objects of kind PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodDisruptionBudgetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PodDisruptionBudgetList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPodDisruptionBudget** +> V1PodDisruptionBudget patchNamespacedPodDisruptionBudget(body) + +partially update the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1PodDisruptionBudget** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedPodDisruptionBudgetStatus** +> V1PodDisruptionBudget patchNamespacedPodDisruptionBudgetStatus(body) + +partially update status of the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodDisruptionBudgetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1PodDisruptionBudget** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPodDisruptionBudget** +> V1PodDisruptionBudget readNamespacedPodDisruptionBudget() + +read the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1PodDisruptionBudget** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedPodDisruptionBudgetStatus** +> V1PodDisruptionBudget readNamespacedPodDisruptionBudgetStatus() + +read status of the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodDisruptionBudgetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1PodDisruptionBudget** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPodDisruptionBudget** +> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudget(body) + +replace the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxUnavailable: "maxUnavailable_example", + minAvailable: "minAvailable_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentHealthy: 1, + desiredHealthy: 1, + disruptedPods: { + "key": new Date('1970-01-01T00:00:00.00Z'), + }, + disruptionsAllowed: 1, + expectedPods: 1, + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodDisruptionBudget**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PodDisruptionBudget** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedPodDisruptionBudgetStatus** +> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudgetStatus(body) + +replace status of the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from ''; +import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxUnavailable: "maxUnavailable_example", + minAvailable: "minAvailable_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentHealthy: 1, + desiredHealthy: 1, + disruptedPods: { + "key": new Date('1970-01-01T00:00:00.00Z'), + }, + disruptionsAllowed: 1, + expectedPods: 1, + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodDisruptionBudgetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodDisruptionBudget**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PodDisruptionBudget** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/RbacAuthorizationApi.md b/src/gen/docs/RbacAuthorizationApi.md new file mode 100644 index 0000000000..e34f61bcf1 --- /dev/null +++ b/src/gen/docs/RbacAuthorizationApi.md @@ -0,0 +1,57 @@ +# .RbacAuthorizationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](RbacAuthorizationApi.md#getAPIGroup) | **GET** /apis/rbac.authorization.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/RbacAuthorizationV1Api.md b/src/gen/docs/RbacAuthorizationV1Api.md new file mode 100644 index 0000000000..29a6b2fc6f --- /dev/null +++ b/src/gen/docs/RbacAuthorizationV1Api.md @@ -0,0 +1,3029 @@ +# .RbacAuthorizationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterRole**](RbacAuthorizationV1Api.md#createClusterRole) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterroles | +[**createClusterRoleBinding**](RbacAuthorizationV1Api.md#createClusterRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | +[**createNamespacedRole**](RbacAuthorizationV1Api.md#createNamespacedRole) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | +[**createNamespacedRoleBinding**](RbacAuthorizationV1Api.md#createNamespacedRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | +[**deleteClusterRole**](RbacAuthorizationV1Api.md#deleteClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**deleteClusterRoleBinding**](RbacAuthorizationV1Api.md#deleteClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**deleteCollectionClusterRole**](RbacAuthorizationV1Api.md#deleteCollectionClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles | +[**deleteCollectionClusterRoleBinding**](RbacAuthorizationV1Api.md#deleteCollectionClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | +[**deleteCollectionNamespacedRole**](RbacAuthorizationV1Api.md#deleteCollectionNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | +[**deleteCollectionNamespacedRoleBinding**](RbacAuthorizationV1Api.md#deleteCollectionNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | +[**deleteNamespacedRole**](RbacAuthorizationV1Api.md#deleteNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**deleteNamespacedRoleBinding**](RbacAuthorizationV1Api.md#deleteNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | +[**getAPIResources**](RbacAuthorizationV1Api.md#getAPIResources) | **GET** /apis/rbac.authorization.k8s.io/v1/ | +[**listClusterRole**](RbacAuthorizationV1Api.md#listClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles | +[**listClusterRoleBinding**](RbacAuthorizationV1Api.md#listClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | +[**listNamespacedRole**](RbacAuthorizationV1Api.md#listNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | +[**listNamespacedRoleBinding**](RbacAuthorizationV1Api.md#listNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | +[**listRoleBindingForAllNamespaces**](RbacAuthorizationV1Api.md#listRoleBindingForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/rolebindings | +[**listRoleForAllNamespaces**](RbacAuthorizationV1Api.md#listRoleForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/roles | +[**patchClusterRole**](RbacAuthorizationV1Api.md#patchClusterRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**patchClusterRoleBinding**](RbacAuthorizationV1Api.md#patchClusterRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**patchNamespacedRole**](RbacAuthorizationV1Api.md#patchNamespacedRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**patchNamespacedRoleBinding**](RbacAuthorizationV1Api.md#patchNamespacedRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | +[**readClusterRole**](RbacAuthorizationV1Api.md#readClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**readClusterRoleBinding**](RbacAuthorizationV1Api.md#readClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**readNamespacedRole**](RbacAuthorizationV1Api.md#readNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**readNamespacedRoleBinding**](RbacAuthorizationV1Api.md#readNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | +[**replaceClusterRole**](RbacAuthorizationV1Api.md#replaceClusterRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**replaceClusterRoleBinding**](RbacAuthorizationV1Api.md#replaceClusterRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**replaceNamespacedRole**](RbacAuthorizationV1Api.md#replaceNamespacedRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**replaceNamespacedRoleBinding**](RbacAuthorizationV1Api.md#replaceNamespacedRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | + + +# **createClusterRole** +> V1ClusterRole createClusterRole(body) + +create a ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiCreateClusterRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateClusterRoleRequest = { + + body: { + aggregationRule: { + clusterRoleSelectors: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + ], + }, + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRole**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ClusterRole** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createClusterRoleBinding** +> V1ClusterRoleBinding createClusterRoleBinding(body) + +create a ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiCreateClusterRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateClusterRoleBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRoleBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ClusterRoleBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedRole** +> V1Role createNamespacedRole(body) + +create a Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiCreateNamespacedRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateNamespacedRoleRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Role**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Role** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedRoleBinding** +> V1RoleBinding createNamespacedRoleBinding(body) + +create a RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RoleBinding**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1RoleBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteClusterRole** +> V1Status deleteClusterRole() + +delete a ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiDeleteClusterRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteClusterRoleBinding** +> V1Status deleteClusterRoleBinding() + +delete a ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionClusterRole** +> V1Status deleteCollectionClusterRole() + +delete collection of ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionClusterRoleBinding** +> V1Status deleteCollectionClusterRoleBinding() + +delete collection of ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedRole** +> V1Status deleteCollectionNamespacedRole() + +delete collection of Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedRoleBinding** +> V1Status deleteCollectionNamespacedRoleBinding() + +delete collection of RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedRole** +> V1Status deleteNamespacedRole() + +delete a Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiDeleteNamespacedRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedRoleBinding** +> V1Status deleteNamespacedRoleBinding() + +delete a RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listClusterRole** +> V1ClusterRoleList listClusterRole() + +list or watch objects of kind ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiListClusterRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListClusterRoleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ClusterRoleList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listClusterRoleBinding** +> V1ClusterRoleBindingList listClusterRoleBinding() + +list or watch objects of kind ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiListClusterRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListClusterRoleBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ClusterRoleBindingList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedRole** +> V1RoleList listNamespacedRole() + +list or watch objects of kind Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiListNamespacedRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListNamespacedRoleRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1RoleList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedRoleBinding** +> V1RoleBindingList listNamespacedRoleBinding() + +list or watch objects of kind RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiListNamespacedRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListNamespacedRoleBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1RoleBindingList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listRoleBindingForAllNamespaces** +> V1RoleBindingList listRoleBindingForAllNamespaces() + +list or watch objects of kind RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listRoleBindingForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1RoleBindingList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listRoleForAllNamespaces** +> V1RoleList listRoleForAllNamespaces() + +list or watch objects of kind Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiListRoleForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListRoleForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listRoleForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1RoleList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchClusterRole** +> V1ClusterRole patchClusterRole(body) + +partially update the specified ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiPatchClusterRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ClusterRole** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchClusterRoleBinding** +> V1ClusterRoleBinding patchClusterRoleBinding(body) + +partially update the specified ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiPatchClusterRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ClusterRoleBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedRole** +> V1Role patchNamespacedRole(body) + +partially update the specified Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiPatchNamespacedRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1Role** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedRoleBinding** +> V1RoleBinding patchNamespacedRoleBinding(body) + +partially update the specified RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1RoleBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readClusterRole** +> V1ClusterRole readClusterRole() + +read the specified ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiReadClusterRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ClusterRole** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readClusterRoleBinding** +> V1ClusterRoleBinding readClusterRoleBinding() + +read the specified ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiReadClusterRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ClusterRoleBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedRole** +> V1Role readNamespacedRole() + +read the specified Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiReadNamespacedRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1Role** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedRoleBinding** +> V1RoleBinding readNamespacedRoleBinding() + +read the specified RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1RoleBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceClusterRole** +> V1ClusterRole replaceClusterRole(body) + +replace the specified ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiReplaceClusterRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + + body: { + aggregationRule: { + clusterRoleSelectors: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + ], + }, + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRole**| | + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ClusterRole** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceClusterRoleBinding** +> V1ClusterRoleBinding replaceClusterRoleBinding(body) + +replace the specified ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRoleBinding**| | + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ClusterRoleBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedRole** +> V1Role replaceNamespacedRole(body) + +replace the specified Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiReplaceNamespacedRoleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Role**| | + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1Role** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedRoleBinding** +> V1RoleBinding replaceNamespacedRoleBinding(body) + +replace the specified RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from ''; +import type { RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RoleBinding**| | + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1RoleBinding** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/ResourceApi.md b/src/gen/docs/ResourceApi.md new file mode 100644 index 0000000000..50b9ec10a7 --- /dev/null +++ b/src/gen/docs/ResourceApi.md @@ -0,0 +1,57 @@ +# .ResourceApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](ResourceApi.md#getAPIGroup) | **GET** /apis/resource.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, ResourceApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/ResourceV1Api.md b/src/gen/docs/ResourceV1Api.md new file mode 100644 index 0000000000..65c694ad1e --- /dev/null +++ b/src/gen/docs/ResourceV1Api.md @@ -0,0 +1,4238 @@ +# .ResourceV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceClass**](ResourceV1Api.md#createDeviceClass) | **POST** /apis/resource.k8s.io/v1/deviceclasses | +[**createNamespacedResourceClaim**](ResourceV1Api.md#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | +[**createNamespacedResourceClaimTemplate**](ResourceV1Api.md#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | +[**createResourceSlice**](ResourceV1Api.md#createResourceSlice) | **POST** /apis/resource.k8s.io/v1/resourceslices | +[**deleteCollectionDeviceClass**](ResourceV1Api.md#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses | +[**deleteCollectionNamespacedResourceClaim**](ResourceV1Api.md#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | +[**deleteCollectionNamespacedResourceClaimTemplate**](ResourceV1Api.md#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | +[**deleteCollectionResourceSlice**](ResourceV1Api.md#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices | +[**deleteDeviceClass**](ResourceV1Api.md#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**deleteNamespacedResourceClaim**](ResourceV1Api.md#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**deleteNamespacedResourceClaimTemplate**](ResourceV1Api.md#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**deleteResourceSlice**](ResourceV1Api.md#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices/{name} | +[**getAPIResources**](ResourceV1Api.md#getAPIResources) | **GET** /apis/resource.k8s.io/v1/ | +[**listDeviceClass**](ResourceV1Api.md#listDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses | +[**listNamespacedResourceClaim**](ResourceV1Api.md#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | +[**listNamespacedResourceClaimTemplate**](ResourceV1Api.md#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | +[**listResourceClaimForAllNamespaces**](ResourceV1Api.md#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaims | +[**listResourceClaimTemplateForAllNamespaces**](ResourceV1Api.md#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaimtemplates | +[**listResourceSlice**](ResourceV1Api.md#listResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices | +[**patchDeviceClass**](ResourceV1Api.md#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**patchNamespacedResourceClaim**](ResourceV1Api.md#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**patchNamespacedResourceClaimStatus**](ResourceV1Api.md#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | +[**patchNamespacedResourceClaimTemplate**](ResourceV1Api.md#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**patchResourceSlice**](ResourceV1Api.md#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1/resourceslices/{name} | +[**readDeviceClass**](ResourceV1Api.md#readDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**readNamespacedResourceClaim**](ResourceV1Api.md#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**readNamespacedResourceClaimStatus**](ResourceV1Api.md#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | +[**readNamespacedResourceClaimTemplate**](ResourceV1Api.md#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**readResourceSlice**](ResourceV1Api.md#readResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices/{name} | +[**replaceDeviceClass**](ResourceV1Api.md#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**replaceNamespacedResourceClaim**](ResourceV1Api.md#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**replaceNamespacedResourceClaimStatus**](ResourceV1Api.md#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | +[**replaceNamespacedResourceClaimTemplate**](ResourceV1Api.md#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**replaceResourceSlice**](ResourceV1Api.md#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1/resourceslices/{name} | + + +# **createDeviceClass** +> V1DeviceClass createDeviceClass(body) + +create a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiCreateDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateDeviceClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeviceClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedResourceClaim** +> ResourceV1ResourceClaim createNamespacedResourceClaim(body) + +create a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiCreateNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **ResourceV1ResourceClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**ResourceV1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedResourceClaimTemplate** +> V1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) + +create a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceClaimTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createResourceSlice** +> V1ResourceSlice createResourceSlice(body) + +create a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiCreateResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateResourceSliceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceSlice**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionDeviceClass** +> V1Status deleteCollectionDeviceClass() + +delete collection of DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiDeleteCollectionDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedResourceClaim** +> V1Status deleteCollectionNamespacedResourceClaim() + +delete collection of ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedResourceClaimTemplate** +> V1Status deleteCollectionNamespacedResourceClaimTemplate() + +delete collection of ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionResourceSlice** +> V1Status deleteCollectionResourceSlice() + +delete collection of ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiDeleteCollectionResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteDeviceClass** +> V1DeviceClass deleteDeviceClass() + +delete a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiDeleteDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedResourceClaim** +> ResourceV1ResourceClaim deleteNamespacedResourceClaim() + +delete a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiDeleteNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**ResourceV1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedResourceClaimTemplate** +> V1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() + +delete a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteResourceSlice** +> V1ResourceSlice deleteResourceSlice() + +delete a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiDeleteResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listDeviceClass** +> V1DeviceClassList listDeviceClass() + +list or watch objects of kind DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiListDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1DeviceClassList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedResourceClaim** +> V1ResourceClaimList listNamespacedResourceClaim() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiListNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ResourceClaimList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedResourceClaimTemplate** +> V1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiListNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ResourceClaimTemplateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listResourceClaimForAllNamespaces** +> V1ResourceClaimList listResourceClaimForAllNamespaces() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiListResourceClaimForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListResourceClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ResourceClaimList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listResourceClaimTemplateForAllNamespaces** +> V1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ResourceClaimTemplateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listResourceSlice** +> V1ResourceSliceList listResourceSlice() + +list or watch objects of kind ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiListResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1ResourceSliceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchDeviceClass** +> V1DeviceClass patchDeviceClass(body) + +partially update the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiPatchDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceClaim** +> ResourceV1ResourceClaim patchNamespacedResourceClaim(body) + +partially update the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiPatchNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**ResourceV1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceClaimStatus** +> ResourceV1ResourceClaim patchNamespacedResourceClaimStatus(body) + +partially update status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiPatchNamespacedResourceClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**ResourceV1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceClaimTemplate** +> V1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) + +partially update the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchResourceSlice** +> V1ResourceSlice patchResourceSlice(body) + +partially update the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiPatchResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readDeviceClass** +> V1DeviceClass readDeviceClass() + +read the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiReadDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceClaim** +> ResourceV1ResourceClaim readNamespacedResourceClaim() + +read the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiReadNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**ResourceV1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceClaimStatus** +> ResourceV1ResourceClaim readNamespacedResourceClaimStatus() + +read status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiReadNamespacedResourceClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**ResourceV1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceClaimTemplate** +> V1ResourceClaimTemplate readNamespacedResourceClaimTemplate() + +read the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiReadNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readResourceSlice** +> V1ResourceSlice readResourceSlice() + +read the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiReadResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceDeviceClass** +> V1DeviceClass replaceDeviceClass(body) + +replace the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiReplaceDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeviceClass**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceClaim** +> ResourceV1ResourceClaim replaceNamespacedResourceClaim(body) + +replace the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiReplaceNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **ResourceV1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**ResourceV1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceClaimStatus** +> ResourceV1ResourceClaim replaceNamespacedResourceClaimStatus(body) + +replace status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **ResourceV1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**ResourceV1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceClaimTemplate** +> V1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) + +replace the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceClaimTemplate**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceResourceSlice** +> V1ResourceSlice replaceResourceSlice(body) + +replace the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from ''; +import type { ResourceV1ApiReplaceResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceSlice**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/ResourceV1alpha3Api.md b/src/gen/docs/ResourceV1alpha3Api.md new file mode 100644 index 0000000000..c1447e6f05 --- /dev/null +++ b/src/gen/docs/ResourceV1alpha3Api.md @@ -0,0 +1,1029 @@ +# .ResourceV1alpha3Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceTaintRule**](ResourceV1alpha3Api.md#createDeviceTaintRule) | **POST** /apis/resource.k8s.io/v1alpha3/devicetaintrules | +[**deleteCollectionDeviceTaintRule**](ResourceV1alpha3Api.md#deleteCollectionDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules | +[**deleteDeviceTaintRule**](ResourceV1alpha3Api.md#deleteDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**getAPIResources**](ResourceV1alpha3Api.md#getAPIResources) | **GET** /apis/resource.k8s.io/v1alpha3/ | +[**listDeviceTaintRule**](ResourceV1alpha3Api.md#listDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules | +[**patchDeviceTaintRule**](ResourceV1alpha3Api.md#patchDeviceTaintRule) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**patchDeviceTaintRuleStatus**](ResourceV1alpha3Api.md#patchDeviceTaintRuleStatus) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | +[**readDeviceTaintRule**](ResourceV1alpha3Api.md#readDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**readDeviceTaintRuleStatus**](ResourceV1alpha3Api.md#readDeviceTaintRuleStatus) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | +[**replaceDeviceTaintRule**](ResourceV1alpha3Api.md#replaceDeviceTaintRule) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**replaceDeviceTaintRuleStatus**](ResourceV1alpha3Api.md#replaceDeviceTaintRuleStatus) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | + + +# **createDeviceTaintRule** +> V1alpha3DeviceTaintRule createDeviceTaintRule(body) + +create a DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; +import type { ResourceV1alpha3ApiCreateDeviceTaintRuleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiCreateDeviceTaintRuleRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + deviceSelector: { + device: "device_example", + driver: "driver_example", + pool: "pool_example", + }, + taint: { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha3DeviceTaintRule**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha3DeviceTaintRule** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionDeviceTaintRule** +> V1Status deleteCollectionDeviceTaintRule() + +delete collection of DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; +import type { ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteDeviceTaintRule** +> V1alpha3DeviceTaintRule deleteDeviceTaintRule() + +delete a DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; +import type { ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1alpha3DeviceTaintRule** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listDeviceTaintRule** +> V1alpha3DeviceTaintRuleList listDeviceTaintRule() + +list or watch objects of kind DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; +import type { ResourceV1alpha3ApiListDeviceTaintRuleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiListDeviceTaintRuleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1alpha3DeviceTaintRuleList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchDeviceTaintRule** +> V1alpha3DeviceTaintRule patchDeviceTaintRule(body) + +partially update the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; +import type { ResourceV1alpha3ApiPatchDeviceTaintRuleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiPatchDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1alpha3DeviceTaintRule** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchDeviceTaintRuleStatus** +> V1alpha3DeviceTaintRule patchDeviceTaintRuleStatus(body) + +partially update status of the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; +import type { ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceTaintRuleStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1alpha3DeviceTaintRule** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readDeviceTaintRule** +> V1alpha3DeviceTaintRule readDeviceTaintRule() + +read the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; +import type { ResourceV1alpha3ApiReadDeviceTaintRuleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReadDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1alpha3DeviceTaintRule** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readDeviceTaintRuleStatus** +> V1alpha3DeviceTaintRule readDeviceTaintRuleStatus() + +read status of the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; +import type { ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest = { + // name of the DeviceTaintRule + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceTaintRuleStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1alpha3DeviceTaintRule** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceDeviceTaintRule** +> V1alpha3DeviceTaintRule replaceDeviceTaintRule(body) + +replace the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; +import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + deviceSelector: { + device: "device_example", + driver: "driver_example", + pool: "pool_example", + }, + taint: { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha3DeviceTaintRule**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha3DeviceTaintRule** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceDeviceTaintRuleStatus** +> V1alpha3DeviceTaintRule replaceDeviceTaintRuleStatus(body) + +replace status of the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from ''; +import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + deviceSelector: { + device: "device_example", + driver: "driver_example", + pool: "pool_example", + }, + taint: { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceTaintRuleStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha3DeviceTaintRule**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha3DeviceTaintRule** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/ResourceV1beta1Api.md b/src/gen/docs/ResourceV1beta1Api.md new file mode 100644 index 0000000000..381e04c42c --- /dev/null +++ b/src/gen/docs/ResourceV1beta1Api.md @@ -0,0 +1,4232 @@ +# .ResourceV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceClass**](ResourceV1beta1Api.md#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta1/deviceclasses | +[**createNamespacedResourceClaim**](ResourceV1beta1Api.md#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | +[**createNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | +[**createResourceSlice**](ResourceV1beta1Api.md#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta1/resourceslices | +[**deleteCollectionDeviceClass**](ResourceV1beta1Api.md#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses | +[**deleteCollectionNamespacedResourceClaim**](ResourceV1beta1Api.md#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | +[**deleteCollectionNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | +[**deleteCollectionResourceSlice**](ResourceV1beta1Api.md#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices | +[**deleteDeviceClass**](ResourceV1beta1Api.md#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**deleteNamespacedResourceClaim**](ResourceV1beta1Api.md#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**deleteNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**deleteResourceSlice**](ResourceV1beta1Api.md#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | +[**getAPIResources**](ResourceV1beta1Api.md#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta1/ | +[**listDeviceClass**](ResourceV1beta1Api.md#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses | +[**listNamespacedResourceClaim**](ResourceV1beta1Api.md#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | +[**listNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | +[**listResourceClaimForAllNamespaces**](ResourceV1beta1Api.md#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaims | +[**listResourceClaimTemplateForAllNamespaces**](ResourceV1beta1Api.md#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaimtemplates | +[**listResourceSlice**](ResourceV1beta1Api.md#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices | +[**patchDeviceClass**](ResourceV1beta1Api.md#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**patchNamespacedResourceClaim**](ResourceV1beta1Api.md#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**patchNamespacedResourceClaimStatus**](ResourceV1beta1Api.md#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | +[**patchNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**patchResourceSlice**](ResourceV1beta1Api.md#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | +[**readDeviceClass**](ResourceV1beta1Api.md#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**readNamespacedResourceClaim**](ResourceV1beta1Api.md#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**readNamespacedResourceClaimStatus**](ResourceV1beta1Api.md#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | +[**readNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**readResourceSlice**](ResourceV1beta1Api.md#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | +[**replaceDeviceClass**](ResourceV1beta1Api.md#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**replaceNamespacedResourceClaim**](ResourceV1beta1Api.md#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**replaceNamespacedResourceClaimStatus**](ResourceV1beta1Api.md#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | +[**replaceNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**replaceResourceSlice**](ResourceV1beta1Api.md#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | + + +# **createDeviceClass** +> V1beta1DeviceClass createDeviceClass(body) + +create a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiCreateDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateDeviceClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1DeviceClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedResourceClaim** +> V1beta1ResourceClaim createNamespacedResourceClaim(body) + +create a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiCreateNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedResourceClaimTemplate** +> V1beta1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) + +create a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaimTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createResourceSlice** +> V1beta1ResourceSlice createResourceSlice(body) + +create a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiCreateResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateResourceSliceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + basic: { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + name: "name_example", + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceSlice**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionDeviceClass** +> V1Status deleteCollectionDeviceClass() + +delete collection of DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiDeleteCollectionDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedResourceClaim** +> V1Status deleteCollectionNamespacedResourceClaim() + +delete collection of ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedResourceClaimTemplate** +> V1Status deleteCollectionNamespacedResourceClaimTemplate() + +delete collection of ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionResourceSlice** +> V1Status deleteCollectionResourceSlice() + +delete collection of ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiDeleteCollectionResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteDeviceClass** +> V1beta1DeviceClass deleteDeviceClass() + +delete a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiDeleteDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1beta1DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedResourceClaim** +> V1beta1ResourceClaim deleteNamespacedResourceClaim() + +delete a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedResourceClaimTemplate** +> V1beta1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() + +delete a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteResourceSlice** +> V1beta1ResourceSlice deleteResourceSlice() + +delete a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiDeleteResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listDeviceClass** +> V1beta1DeviceClassList listDeviceClass() + +list or watch objects of kind DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiListDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1DeviceClassList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedResourceClaim** +> V1beta1ResourceClaimList listNamespacedResourceClaim() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiListNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaimList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedResourceClaimTemplate** +> V1beta1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaimTemplateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listResourceClaimForAllNamespaces** +> V1beta1ResourceClaimList listResourceClaimForAllNamespaces() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaimList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listResourceClaimTemplateForAllNamespaces** +> V1beta1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaimTemplateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listResourceSlice** +> V1beta1ResourceSliceList listResourceSlice() + +list or watch objects of kind ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiListResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceSliceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchDeviceClass** +> V1beta1DeviceClass patchDeviceClass(body) + +partially update the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiPatchDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceClaim** +> V1beta1ResourceClaim patchNamespacedResourceClaim(body) + +partially update the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiPatchNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceClaimStatus** +> V1beta1ResourceClaim patchNamespacedResourceClaimStatus(body) + +partially update status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceClaimTemplate** +> V1beta1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) + +partially update the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchResourceSlice** +> V1beta1ResourceSlice patchResourceSlice(body) + +partially update the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiPatchResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readDeviceClass** +> V1beta1DeviceClass readDeviceClass() + +read the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiReadDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceClaim** +> V1beta1ResourceClaim readNamespacedResourceClaim() + +read the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiReadNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceClaimStatus** +> V1beta1ResourceClaim readNamespacedResourceClaimStatus() + +read status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceClaimTemplate** +> V1beta1ResourceClaimTemplate readNamespacedResourceClaimTemplate() + +read the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readResourceSlice** +> V1beta1ResourceSlice readResourceSlice() + +read the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiReadResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceDeviceClass** +> V1beta1DeviceClass replaceDeviceClass(body) + +replace the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiReplaceDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1DeviceClass**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceClaim** +> V1beta1ResourceClaim replaceNamespacedResourceClaim(body) + +replace the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceClaimStatus** +> V1beta1ResourceClaim replaceNamespacedResourceClaimStatus(body) + +replace status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceClaimTemplate** +> V1beta1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) + +replace the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaimTemplate**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceResourceSlice** +> V1beta1ResourceSlice replaceResourceSlice(body) + +replace the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from ''; +import type { ResourceV1beta1ApiReplaceResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + basic: { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + name: "name_example", + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceSlice**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/ResourceV1beta2Api.md b/src/gen/docs/ResourceV1beta2Api.md new file mode 100644 index 0000000000..c6fec541f3 --- /dev/null +++ b/src/gen/docs/ResourceV1beta2Api.md @@ -0,0 +1,4238 @@ +# .ResourceV1beta2Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceClass**](ResourceV1beta2Api.md#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta2/deviceclasses | +[**createNamespacedResourceClaim**](ResourceV1beta2Api.md#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | +[**createNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | +[**createResourceSlice**](ResourceV1beta2Api.md#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta2/resourceslices | +[**deleteCollectionDeviceClass**](ResourceV1beta2Api.md#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses | +[**deleteCollectionNamespacedResourceClaim**](ResourceV1beta2Api.md#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | +[**deleteCollectionNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | +[**deleteCollectionResourceSlice**](ResourceV1beta2Api.md#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices | +[**deleteDeviceClass**](ResourceV1beta2Api.md#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**deleteNamespacedResourceClaim**](ResourceV1beta2Api.md#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**deleteNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**deleteResourceSlice**](ResourceV1beta2Api.md#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | +[**getAPIResources**](ResourceV1beta2Api.md#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta2/ | +[**listDeviceClass**](ResourceV1beta2Api.md#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses | +[**listNamespacedResourceClaim**](ResourceV1beta2Api.md#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | +[**listNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | +[**listResourceClaimForAllNamespaces**](ResourceV1beta2Api.md#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaims | +[**listResourceClaimTemplateForAllNamespaces**](ResourceV1beta2Api.md#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaimtemplates | +[**listResourceSlice**](ResourceV1beta2Api.md#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices | +[**patchDeviceClass**](ResourceV1beta2Api.md#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**patchNamespacedResourceClaim**](ResourceV1beta2Api.md#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**patchNamespacedResourceClaimStatus**](ResourceV1beta2Api.md#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | +[**patchNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**patchResourceSlice**](ResourceV1beta2Api.md#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | +[**readDeviceClass**](ResourceV1beta2Api.md#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**readNamespacedResourceClaim**](ResourceV1beta2Api.md#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**readNamespacedResourceClaimStatus**](ResourceV1beta2Api.md#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | +[**readNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**readResourceSlice**](ResourceV1beta2Api.md#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | +[**replaceDeviceClass**](ResourceV1beta2Api.md#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**replaceNamespacedResourceClaim**](ResourceV1beta2Api.md#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**replaceNamespacedResourceClaimStatus**](ResourceV1beta2Api.md#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | +[**replaceNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**replaceResourceSlice**](ResourceV1beta2Api.md#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | + + +# **createDeviceClass** +> V1beta2DeviceClass createDeviceClass(body) + +create a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiCreateDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateDeviceClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2DeviceClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta2DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedResourceClaim** +> V1beta2ResourceClaim createNamespacedResourceClaim(body) + +create a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiCreateNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedResourceClaimTemplate** +> V1beta2ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) + +create a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaimTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createResourceSlice** +> V1beta2ResourceSlice createResourceSlice(body) + +create a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiCreateResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateResourceSliceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceSlice**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionDeviceClass** +> V1Status deleteCollectionDeviceClass() + +delete collection of DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiDeleteCollectionDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedResourceClaim** +> V1Status deleteCollectionNamespacedResourceClaim() + +delete collection of ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedResourceClaimTemplate** +> V1Status deleteCollectionNamespacedResourceClaimTemplate() + +delete collection of ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionResourceSlice** +> V1Status deleteCollectionResourceSlice() + +delete collection of ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiDeleteCollectionResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteDeviceClass** +> V1beta2DeviceClass deleteDeviceClass() + +delete a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiDeleteDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1beta2DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedResourceClaim** +> V1beta2ResourceClaim deleteNamespacedResourceClaim() + +delete a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedResourceClaimTemplate** +> V1beta2ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() + +delete a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteResourceSlice** +> V1beta2ResourceSlice deleteResourceSlice() + +delete a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiDeleteResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listDeviceClass** +> V1beta2DeviceClassList listDeviceClass() + +list or watch objects of kind DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiListDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta2DeviceClassList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedResourceClaim** +> V1beta2ResourceClaimList listNamespacedResourceClaim() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiListNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaimList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedResourceClaimTemplate** +> V1beta2ResourceClaimTemplateList listNamespacedResourceClaimTemplate() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaimTemplateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listResourceClaimForAllNamespaces** +> V1beta2ResourceClaimList listResourceClaimForAllNamespaces() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaimList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listResourceClaimTemplateForAllNamespaces** +> V1beta2ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaimTemplateList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listResourceSlice** +> V1beta2ResourceSliceList listResourceSlice() + +list or watch objects of kind ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiListResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceSliceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchDeviceClass** +> V1beta2DeviceClass patchDeviceClass(body) + +partially update the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiPatchDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta2DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceClaim** +> V1beta2ResourceClaim patchNamespacedResourceClaim(body) + +partially update the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiPatchNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceClaimStatus** +> V1beta2ResourceClaim patchNamespacedResourceClaimStatus(body) + +partially update status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedResourceClaimTemplate** +> V1beta2ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) + +partially update the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchResourceSlice** +> V1beta2ResourceSlice patchResourceSlice(body) + +partially update the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiPatchResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readDeviceClass** +> V1beta2DeviceClass readDeviceClass() + +read the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiReadDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta2DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceClaim** +> V1beta2ResourceClaim readNamespacedResourceClaim() + +read the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiReadNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceClaimStatus** +> V1beta2ResourceClaim readNamespacedResourceClaimStatus() + +read status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedResourceClaimTemplate** +> V1beta2ResourceClaimTemplate readNamespacedResourceClaimTemplate() + +read the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readResourceSlice** +> V1beta2ResourceSlice readResourceSlice() + +read the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiReadResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceDeviceClass** +> V1beta2DeviceClass replaceDeviceClass(body) + +replace the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiReplaceDeviceClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2DeviceClass**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta2DeviceClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceClaim** +> V1beta2ResourceClaim replaceNamespacedResourceClaim(body) + +replace the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceClaimStatus** +> V1beta2ResourceClaim replaceNamespacedResourceClaimStatus(body) + +replace status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaim** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedResourceClaimTemplate** +> V1beta2ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) + +replace the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaimTemplate**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceClaimTemplate** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceResourceSlice** +> V1beta2ResourceSlice replaceResourceSlice(body) + +replace the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from ''; +import type { ResourceV1beta2ApiReplaceResourceSliceRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceSlice**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta2ResourceSlice** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/SchedulingApi.md b/src/gen/docs/SchedulingApi.md new file mode 100644 index 0000000000..47dbb02fab --- /dev/null +++ b/src/gen/docs/SchedulingApi.md @@ -0,0 +1,57 @@ +# .SchedulingApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](SchedulingApi.md#getAPIGroup) | **GET** /apis/scheduling.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, SchedulingApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/SchedulingV1Api.md b/src/gen/docs/SchedulingV1Api.md new file mode 100644 index 0000000000..cea65ea8fa --- /dev/null +++ b/src/gen/docs/SchedulingV1Api.md @@ -0,0 +1,714 @@ +# .SchedulingV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createPriorityClass**](SchedulingV1Api.md#createPriorityClass) | **POST** /apis/scheduling.k8s.io/v1/priorityclasses | +[**deleteCollectionPriorityClass**](SchedulingV1Api.md#deleteCollectionPriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses | +[**deletePriorityClass**](SchedulingV1Api.md#deletePriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | +[**getAPIResources**](SchedulingV1Api.md#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1/ | +[**listPriorityClass**](SchedulingV1Api.md#listPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses | +[**patchPriorityClass**](SchedulingV1Api.md#patchPriorityClass) | **PATCH** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | +[**readPriorityClass**](SchedulingV1Api.md#readPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | +[**replacePriorityClass**](SchedulingV1Api.md#replacePriorityClass) | **PUT** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | + + +# **createPriorityClass** +> V1PriorityClass createPriorityClass(body) + +create a PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from ''; +import type { SchedulingV1ApiCreatePriorityClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiCreatePriorityClassRequest = { + + body: { + apiVersion: "apiVersion_example", + description: "description_example", + globalDefault: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + preemptionPolicy: "preemptionPolicy_example", + value: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PriorityClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionPriorityClass** +> V1Status deleteCollectionPriorityClass() + +delete collection of PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from ''; +import type { SchedulingV1ApiDeleteCollectionPriorityClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiDeleteCollectionPriorityClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deletePriorityClass** +> V1Status deletePriorityClass() + +delete a PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from ''; +import type { SchedulingV1ApiDeletePriorityClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiDeletePriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deletePriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listPriorityClass** +> V1PriorityClassList listPriorityClass() + +list or watch objects of kind PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from ''; +import type { SchedulingV1ApiListPriorityClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiListPriorityClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1PriorityClassList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchPriorityClass** +> V1PriorityClass patchPriorityClass(body) + +partially update the specified PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from ''; +import type { SchedulingV1ApiPatchPriorityClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiPatchPriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1PriorityClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readPriorityClass** +> V1PriorityClass readPriorityClass() + +read the specified PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from ''; +import type { SchedulingV1ApiReadPriorityClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiReadPriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1PriorityClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replacePriorityClass** +> V1PriorityClass replacePriorityClass(body) + +replace the specified PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from ''; +import type { SchedulingV1ApiReplacePriorityClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiReplacePriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + description: "description_example", + globalDefault: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + preemptionPolicy: "preemptionPolicy_example", + value: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityClass**| | + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1PriorityClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/SchedulingV1alpha1Api.md b/src/gen/docs/SchedulingV1alpha1Api.md new file mode 100644 index 0000000000..e2734e2b0c --- /dev/null +++ b/src/gen/docs/SchedulingV1alpha1Api.md @@ -0,0 +1,848 @@ +# .SchedulingV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedWorkload**](SchedulingV1alpha1Api.md#createNamespacedWorkload) | **POST** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | +[**deleteCollectionNamespacedWorkload**](SchedulingV1alpha1Api.md#deleteCollectionNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | +[**deleteNamespacedWorkload**](SchedulingV1alpha1Api.md#deleteNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | +[**getAPIResources**](SchedulingV1alpha1Api.md#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1alpha1/ | +[**listNamespacedWorkload**](SchedulingV1alpha1Api.md#listNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | +[**listWorkloadForAllNamespaces**](SchedulingV1alpha1Api.md#listWorkloadForAllNamespaces) | **GET** /apis/scheduling.k8s.io/v1alpha1/workloads | +[**patchNamespacedWorkload**](SchedulingV1alpha1Api.md#patchNamespacedWorkload) | **PATCH** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | +[**readNamespacedWorkload**](SchedulingV1alpha1Api.md#readNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | +[**replaceNamespacedWorkload**](SchedulingV1alpha1Api.md#replaceNamespacedWorkload) | **PUT** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | + + +# **createNamespacedWorkload** +> V1alpha1Workload createNamespacedWorkload(body) + +create a Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from ''; +import type { SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controllerRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + podGroups: [ + { + name: "name_example", + policy: { + basic: {}, + gang: { + minCount: 1, + }, + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1Workload**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1Workload** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedWorkload** +> V1Status deleteCollectionNamespacedWorkload() + +delete collection of Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from ''; +import type { SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedWorkload** +> V1Status deleteNamespacedWorkload() + +delete a Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from ''; +import type { SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedWorkload** +> V1alpha1WorkloadList listNamespacedWorkload() + +list or watch objects of kind Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from ''; +import type { SchedulingV1alpha1ApiListNamespacedWorkloadRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiListNamespacedWorkloadRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1alpha1WorkloadList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listWorkloadForAllNamespaces** +> V1alpha1WorkloadList listWorkloadForAllNamespaces() + +list or watch objects of kind Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from ''; +import type { SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listWorkloadForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1alpha1WorkloadList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedWorkload** +> V1alpha1Workload patchNamespacedWorkload(body) + +partially update the specified Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from ''; +import type { SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1alpha1Workload** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedWorkload** +> V1alpha1Workload readNamespacedWorkload() + +read the specified Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from ''; +import type { SchedulingV1alpha1ApiReadNamespacedWorkloadRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiReadNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1alpha1Workload** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedWorkload** +> V1alpha1Workload replaceNamespacedWorkload(body) + +replace the specified Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from ''; +import type { SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controllerRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + podGroups: [ + { + name: "name_example", + policy: { + basic: {}, + gang: { + minCount: 1, + }, + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1Workload**| | + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1alpha1Workload** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/StorageApi.md b/src/gen/docs/StorageApi.md new file mode 100644 index 0000000000..58bbcaca8f --- /dev/null +++ b/src/gen/docs/StorageApi.md @@ -0,0 +1,57 @@ +# .StorageApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](StorageApi.md#getAPIGroup) | **GET** /apis/storage.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, StorageApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/StorageV1Api.md b/src/gen/docs/StorageV1Api.md new file mode 100644 index 0000000000..85f33ae266 --- /dev/null +++ b/src/gen/docs/StorageV1Api.md @@ -0,0 +1,5303 @@ +# .StorageV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createCSIDriver**](StorageV1Api.md#createCSIDriver) | **POST** /apis/storage.k8s.io/v1/csidrivers | +[**createCSINode**](StorageV1Api.md#createCSINode) | **POST** /apis/storage.k8s.io/v1/csinodes | +[**createNamespacedCSIStorageCapacity**](StorageV1Api.md#createNamespacedCSIStorageCapacity) | **POST** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | +[**createStorageClass**](StorageV1Api.md#createStorageClass) | **POST** /apis/storage.k8s.io/v1/storageclasses | +[**createVolumeAttachment**](StorageV1Api.md#createVolumeAttachment) | **POST** /apis/storage.k8s.io/v1/volumeattachments | +[**createVolumeAttributesClass**](StorageV1Api.md#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1/volumeattributesclasses | +[**deleteCSIDriver**](StorageV1Api.md#deleteCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**deleteCSINode**](StorageV1Api.md#deleteCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes/{name} | +[**deleteCollectionCSIDriver**](StorageV1Api.md#deleteCollectionCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers | +[**deleteCollectionCSINode**](StorageV1Api.md#deleteCollectionCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes | +[**deleteCollectionNamespacedCSIStorageCapacity**](StorageV1Api.md#deleteCollectionNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | +[**deleteCollectionStorageClass**](StorageV1Api.md#deleteCollectionStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses | +[**deleteCollectionVolumeAttachment**](StorageV1Api.md#deleteCollectionVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments | +[**deleteCollectionVolumeAttributesClass**](StorageV1Api.md#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses | +[**deleteNamespacedCSIStorageCapacity**](StorageV1Api.md#deleteNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**deleteStorageClass**](StorageV1Api.md#deleteStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**deleteVolumeAttachment**](StorageV1Api.md#deleteVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**deleteVolumeAttributesClass**](StorageV1Api.md#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | +[**getAPIResources**](StorageV1Api.md#getAPIResources) | **GET** /apis/storage.k8s.io/v1/ | +[**listCSIDriver**](StorageV1Api.md#listCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers | +[**listCSINode**](StorageV1Api.md#listCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes | +[**listCSIStorageCapacityForAllNamespaces**](StorageV1Api.md#listCSIStorageCapacityForAllNamespaces) | **GET** /apis/storage.k8s.io/v1/csistoragecapacities | +[**listNamespacedCSIStorageCapacity**](StorageV1Api.md#listNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | +[**listStorageClass**](StorageV1Api.md#listStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses | +[**listVolumeAttachment**](StorageV1Api.md#listVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments | +[**listVolumeAttributesClass**](StorageV1Api.md#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses | +[**patchCSIDriver**](StorageV1Api.md#patchCSIDriver) | **PATCH** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**patchCSINode**](StorageV1Api.md#patchCSINode) | **PATCH** /apis/storage.k8s.io/v1/csinodes/{name} | +[**patchNamespacedCSIStorageCapacity**](StorageV1Api.md#patchNamespacedCSIStorageCapacity) | **PATCH** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**patchStorageClass**](StorageV1Api.md#patchStorageClass) | **PATCH** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**patchVolumeAttachment**](StorageV1Api.md#patchVolumeAttachment) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**patchVolumeAttachmentStatus**](StorageV1Api.md#patchVolumeAttachmentStatus) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | +[**patchVolumeAttributesClass**](StorageV1Api.md#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | +[**readCSIDriver**](StorageV1Api.md#readCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**readCSINode**](StorageV1Api.md#readCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes/{name} | +[**readNamespacedCSIStorageCapacity**](StorageV1Api.md#readNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**readStorageClass**](StorageV1Api.md#readStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**readVolumeAttachment**](StorageV1Api.md#readVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**readVolumeAttachmentStatus**](StorageV1Api.md#readVolumeAttachmentStatus) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | +[**readVolumeAttributesClass**](StorageV1Api.md#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | +[**replaceCSIDriver**](StorageV1Api.md#replaceCSIDriver) | **PUT** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**replaceCSINode**](StorageV1Api.md#replaceCSINode) | **PUT** /apis/storage.k8s.io/v1/csinodes/{name} | +[**replaceNamespacedCSIStorageCapacity**](StorageV1Api.md#replaceNamespacedCSIStorageCapacity) | **PUT** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**replaceStorageClass**](StorageV1Api.md#replaceStorageClass) | **PUT** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**replaceVolumeAttachment**](StorageV1Api.md#replaceVolumeAttachment) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**replaceVolumeAttachmentStatus**](StorageV1Api.md#replaceVolumeAttachmentStatus) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | +[**replaceVolumeAttributesClass**](StorageV1Api.md#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | + + +# **createCSIDriver** +> V1CSIDriver createCSIDriver(body) + +create a CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiCreateCSIDriverRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateCSIDriverRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attachRequired: true, + fsGroupPolicy: "fsGroupPolicy_example", + nodeAllocatableUpdatePeriodSeconds: 1, + podInfoOnMount: true, + requiresRepublish: true, + seLinuxMount: true, + serviceAccountTokenInSecrets: true, + storageCapacity: true, + tokenRequests: [ + { + audience: "audience_example", + expirationSeconds: 1, + }, + ], + volumeLifecycleModes: [ + "volumeLifecycleModes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIDriver**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CSIDriver** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createCSINode** +> V1CSINode createCSINode(body) + +create a CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiCreateCSINodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateCSINodeRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + drivers: [ + { + allocatable: { + count: 1, + }, + name: "name_example", + nodeID: "nodeID_example", + topologyKeys: [ + "topologyKeys_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSINode**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CSINode** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createNamespacedCSIStorageCapacity** +> V1CSIStorageCapacity createNamespacedCSIStorageCapacity(body) + +create a CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiCreateNamespacedCSIStorageCapacityRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateNamespacedCSIStorageCapacityRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + capacity: "capacity_example", + kind: "kind_example", + maximumVolumeSize: "maximumVolumeSize_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + nodeTopology: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIStorageCapacity**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CSIStorageCapacity** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createStorageClass** +> V1StorageClass createStorageClass(body) + +create a StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiCreateStorageClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateStorageClassRequest = { + + body: { + allowVolumeExpansion: true, + allowedTopologies: [ + { + matchLabelExpressions: [ + { + key: "key_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + mountOptions: [ + "mountOptions_example", + ], + parameters: { + "key": "key_example", + }, + provisioner: "provisioner_example", + reclaimPolicy: "reclaimPolicy_example", + volumeBindingMode: "volumeBindingMode_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StorageClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1StorageClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createVolumeAttachment** +> V1VolumeAttachment createVolumeAttachment(body) + +create a VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiCreateVolumeAttachmentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateVolumeAttachmentRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attacher: "attacher_example", + nodeName: "nodeName_example", + source: { + inlineVolumeSpec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + persistentVolumeName: "persistentVolumeName_example", + }, + }, + status: { + attachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + attached: true, + attachmentMetadata: { + "key": "key_example", + }, + detachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttachment**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttachment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **createVolumeAttributesClass** +> V1VolumeAttributesClass createVolumeAttributesClass(body) + +create a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiCreateVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateVolumeAttributesClassRequest = { + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttributesClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttributesClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCSIDriver** +> V1CSIDriver deleteCSIDriver() + +delete a CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteCSIDriverRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1CSIDriver** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCSINode** +> V1CSINode deleteCSINode() + +delete a CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteCSINodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCSINodeRequest = { + // name of the CSINode + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1CSINode** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionCSIDriver** +> V1Status deleteCollectionCSIDriver() + +delete collection of CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteCollectionCSIDriverRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionCSIDriverRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionCSINode** +> V1Status deleteCollectionCSINode() + +delete collection of CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteCollectionCSINodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionCSINodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionNamespacedCSIStorageCapacity** +> V1Status deleteCollectionNamespacedCSIStorageCapacity() + +delete collection of CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionStorageClass** +> V1Status deleteCollectionStorageClass() + +delete collection of StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteCollectionStorageClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionStorageClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionVolumeAttachment** +> V1Status deleteCollectionVolumeAttachment() + +delete collection of VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteCollectionVolumeAttachmentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionVolumeAttachmentRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionVolumeAttributesClass** +> V1Status deleteCollectionVolumeAttributesClass() + +delete collection of VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteCollectionVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteNamespacedCSIStorageCapacity** +> V1Status deleteNamespacedCSIStorageCapacity() + +delete a CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteStorageClass** +> V1StorageClass deleteStorageClass() + +delete a StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteStorageClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteStorageClassRequest = { + // name of the StorageClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1StorageClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteVolumeAttachment** +> V1VolumeAttachment deleteVolumeAttachment() + +delete a VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteVolumeAttachmentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttachment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteVolumeAttributesClass** +> V1VolumeAttributesClass deleteVolumeAttributesClass() + +delete a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiDeleteVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttributesClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listCSIDriver** +> V1CSIDriverList listCSIDriver() + +list or watch objects of kind CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiListCSIDriverRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListCSIDriverRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1CSIDriverList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listCSINode** +> V1CSINodeList listCSINode() + +list or watch objects of kind CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiListCSINodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListCSINodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1CSINodeList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listCSIStorageCapacityForAllNamespaces** +> V1CSIStorageCapacityList listCSIStorageCapacityForAllNamespaces() + +list or watch objects of kind CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCSIStorageCapacityForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1CSIStorageCapacityList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listNamespacedCSIStorageCapacity** +> V1CSIStorageCapacityList listNamespacedCSIStorageCapacity() + +list or watch objects of kind CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiListNamespacedCSIStorageCapacityRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListNamespacedCSIStorageCapacityRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1CSIStorageCapacityList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listStorageClass** +> V1StorageClassList listStorageClass() + +list or watch objects of kind StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiListStorageClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListStorageClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1StorageClassList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listVolumeAttachment** +> V1VolumeAttachmentList listVolumeAttachment() + +list or watch objects of kind VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiListVolumeAttachmentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListVolumeAttachmentRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttachmentList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listVolumeAttributesClass** +> V1VolumeAttributesClassList listVolumeAttributesClass() + +list or watch objects of kind VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiListVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttributesClassList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchCSIDriver** +> V1CSIDriver patchCSIDriver(body) + +partially update the specified CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiPatchCSIDriverRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1CSIDriver** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchCSINode** +> V1CSINode patchCSINode(body) + +partially update the specified CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiPatchCSINodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchCSINodeRequest = { + // name of the CSINode + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1CSINode** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchNamespacedCSIStorageCapacity** +> V1CSIStorageCapacity patchNamespacedCSIStorageCapacity(body) + +partially update the specified CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiPatchNamespacedCSIStorageCapacityRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1CSIStorageCapacity** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchStorageClass** +> V1StorageClass patchStorageClass(body) + +partially update the specified StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiPatchStorageClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchStorageClassRequest = { + // name of the StorageClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1StorageClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchVolumeAttachment** +> V1VolumeAttachment patchVolumeAttachment(body) + +partially update the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiPatchVolumeAttachmentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttachment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchVolumeAttachmentStatus** +> V1VolumeAttachment patchVolumeAttachmentStatus(body) + +partially update status of the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiPatchVolumeAttachmentStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchVolumeAttachmentStatusRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttachmentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttachment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchVolumeAttributesClass** +> V1VolumeAttributesClass patchVolumeAttributesClass(body) + +partially update the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiPatchVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttributesClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readCSIDriver** +> V1CSIDriver readCSIDriver() + +read the specified CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReadCSIDriverRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1CSIDriver** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readCSINode** +> V1CSINode readCSINode() + +read the specified CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReadCSINodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadCSINodeRequest = { + // name of the CSINode + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1CSINode** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readNamespacedCSIStorageCapacity** +> V1CSIStorageCapacity readNamespacedCSIStorageCapacity() + +read the specified CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReadNamespacedCSIStorageCapacityRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1CSIStorageCapacity** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readStorageClass** +> V1StorageClass readStorageClass() + +read the specified StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReadStorageClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadStorageClassRequest = { + // name of the StorageClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1StorageClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readVolumeAttachment** +> V1VolumeAttachment readVolumeAttachment() + +read the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReadVolumeAttachmentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttachment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readVolumeAttachmentStatus** +> V1VolumeAttachment readVolumeAttachmentStatus() + +read status of the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReadVolumeAttachmentStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadVolumeAttachmentStatusRequest = { + // name of the VolumeAttachment + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttachmentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttachment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readVolumeAttributesClass** +> V1VolumeAttributesClass readVolumeAttributesClass() + +read the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReadVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttributesClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceCSIDriver** +> V1CSIDriver replaceCSIDriver(body) + +replace the specified CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReplaceCSIDriverRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attachRequired: true, + fsGroupPolicy: "fsGroupPolicy_example", + nodeAllocatableUpdatePeriodSeconds: 1, + podInfoOnMount: true, + requiresRepublish: true, + seLinuxMount: true, + serviceAccountTokenInSecrets: true, + storageCapacity: true, + tokenRequests: [ + { + audience: "audience_example", + expirationSeconds: 1, + }, + ], + volumeLifecycleModes: [ + "volumeLifecycleModes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIDriver**| | + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CSIDriver** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceCSINode** +> V1CSINode replaceCSINode(body) + +replace the specified CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReplaceCSINodeRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceCSINodeRequest = { + // name of the CSINode + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + drivers: [ + { + allocatable: { + count: 1, + }, + name: "name_example", + nodeID: "nodeID_example", + topologyKeys: [ + "topologyKeys_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSINode**| | + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CSINode** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceNamespacedCSIStorageCapacity** +> V1CSIStorageCapacity replaceNamespacedCSIStorageCapacity(body) + +replace the specified CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + capacity: "capacity_example", + kind: "kind_example", + maximumVolumeSize: "maximumVolumeSize_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + nodeTopology: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIStorageCapacity**| | + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1CSIStorageCapacity** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceStorageClass** +> V1StorageClass replaceStorageClass(body) + +replace the specified StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReplaceStorageClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceStorageClassRequest = { + // name of the StorageClass + name: "name_example", + + body: { + allowVolumeExpansion: true, + allowedTopologies: [ + { + matchLabelExpressions: [ + { + key: "key_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + mountOptions: [ + "mountOptions_example", + ], + parameters: { + "key": "key_example", + }, + provisioner: "provisioner_example", + reclaimPolicy: "reclaimPolicy_example", + volumeBindingMode: "volumeBindingMode_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StorageClass**| | + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1StorageClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceVolumeAttachment** +> V1VolumeAttachment replaceVolumeAttachment(body) + +replace the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReplaceVolumeAttachmentRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attacher: "attacher_example", + nodeName: "nodeName_example", + source: { + inlineVolumeSpec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + persistentVolumeName: "persistentVolumeName_example", + }, + }, + status: { + attachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + attached: true, + attachmentMetadata: { + "key": "key_example", + }, + detachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttachment**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttachment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceVolumeAttachmentStatus** +> V1VolumeAttachment replaceVolumeAttachmentStatus(body) + +replace status of the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReplaceVolumeAttachmentStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceVolumeAttachmentStatusRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attacher: "attacher_example", + nodeName: "nodeName_example", + source: { + inlineVolumeSpec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + persistentVolumeName: "persistentVolumeName_example", + }, + }, + status: { + attachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + attached: true, + attachmentMetadata: { + "key": "key_example", + }, + detachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttachmentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttachment**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttachment** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceVolumeAttributesClass** +> V1VolumeAttributesClass replaceVolumeAttributesClass(body) + +replace the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from ''; +import type { StorageV1ApiReplaceVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttributesClass**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1VolumeAttributesClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/StorageV1beta1Api.md b/src/gen/docs/StorageV1beta1Api.md new file mode 100644 index 0000000000..cd38b76ae0 --- /dev/null +++ b/src/gen/docs/StorageV1beta1Api.md @@ -0,0 +1,714 @@ +# .StorageV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createVolumeAttributesClass**](StorageV1beta1Api.md#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | +[**deleteCollectionVolumeAttributesClass**](StorageV1beta1Api.md#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | +[**deleteVolumeAttributesClass**](StorageV1beta1Api.md#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | +[**getAPIResources**](StorageV1beta1Api.md#getAPIResources) | **GET** /apis/storage.k8s.io/v1beta1/ | +[**listVolumeAttributesClass**](StorageV1beta1Api.md#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | +[**patchVolumeAttributesClass**](StorageV1beta1Api.md#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | +[**readVolumeAttributesClass**](StorageV1beta1Api.md#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | +[**replaceVolumeAttributesClass**](StorageV1beta1Api.md#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | + + +# **createVolumeAttributesClass** +> V1beta1VolumeAttributesClass createVolumeAttributesClass(body) + +create a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from ''; +import type { StorageV1beta1ApiCreateVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiCreateVolumeAttributesClassRequest = { + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1VolumeAttributesClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1VolumeAttributesClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionVolumeAttributesClass** +> V1Status deleteCollectionVolumeAttributesClass() + +delete collection of VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from ''; +import type { StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteVolumeAttributesClass** +> V1beta1VolumeAttributesClass deleteVolumeAttributesClass() + +delete a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from ''; +import type { StorageV1beta1ApiDeleteVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiDeleteVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1beta1VolumeAttributesClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listVolumeAttributesClass** +> V1beta1VolumeAttributesClassList listVolumeAttributesClass() + +list or watch objects of kind VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from ''; +import type { StorageV1beta1ApiListVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiListVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1VolumeAttributesClassList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchVolumeAttributesClass** +> V1beta1VolumeAttributesClass patchVolumeAttributesClass(body) + +partially update the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from ''; +import type { StorageV1beta1ApiPatchVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiPatchVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1VolumeAttributesClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readVolumeAttributesClass** +> V1beta1VolumeAttributesClass readVolumeAttributesClass() + +read the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from ''; +import type { StorageV1beta1ApiReadVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiReadVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1VolumeAttributesClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceVolumeAttributesClass** +> V1beta1VolumeAttributesClass replaceVolumeAttributesClass(body) + +replace the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from ''; +import type { StorageV1beta1ApiReplaceVolumeAttributesClassRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiReplaceVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1VolumeAttributesClass**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1VolumeAttributesClass** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/StoragemigrationApi.md b/src/gen/docs/StoragemigrationApi.md new file mode 100644 index 0000000000..3b13b5b46d --- /dev/null +++ b/src/gen/docs/StoragemigrationApi.md @@ -0,0 +1,57 @@ +# .StoragemigrationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](StoragemigrationApi.md#getAPIGroup) | **GET** /apis/storagemigration.k8s.io/ | + + +# **getAPIGroup** +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, StoragemigrationApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIGroup** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/StoragemigrationV1beta1Api.md b/src/gen/docs/StoragemigrationV1beta1Api.md new file mode 100644 index 0000000000..566ff5f7f5 --- /dev/null +++ b/src/gen/docs/StoragemigrationV1beta1Api.md @@ -0,0 +1,1011 @@ +# .StoragemigrationV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createStorageVersionMigration**](StoragemigrationV1beta1Api.md#createStorageVersionMigration) | **POST** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | +[**deleteCollectionStorageVersionMigration**](StoragemigrationV1beta1Api.md#deleteCollectionStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | +[**deleteStorageVersionMigration**](StoragemigrationV1beta1Api.md#deleteStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**getAPIResources**](StoragemigrationV1beta1Api.md#getAPIResources) | **GET** /apis/storagemigration.k8s.io/v1beta1/ | +[**listStorageVersionMigration**](StoragemigrationV1beta1Api.md#listStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | +[**patchStorageVersionMigration**](StoragemigrationV1beta1Api.md#patchStorageVersionMigration) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**patchStorageVersionMigrationStatus**](StoragemigrationV1beta1Api.md#patchStorageVersionMigrationStatus) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | +[**readStorageVersionMigration**](StoragemigrationV1beta1Api.md#readStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**readStorageVersionMigrationStatus**](StoragemigrationV1beta1Api.md#readStorageVersionMigrationStatus) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | +[**replaceStorageVersionMigration**](StoragemigrationV1beta1Api.md#replaceStorageVersionMigration) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**replaceStorageVersionMigrationStatus**](StoragemigrationV1beta1Api.md#replaceStorageVersionMigrationStatus) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | + + +# **createStorageVersionMigration** +> V1beta1StorageVersionMigration createStorageVersionMigration(body) + +create a StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; +import type { StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + resource: { + group: "group_example", + resource: "resource_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + resourceVersion: "resourceVersion_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1StorageVersionMigration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1StorageVersionMigration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteCollectionStorageVersionMigration** +> V1Status deleteCollectionStorageVersionMigration() + +delete collection of StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; +import type { StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **deleteStorageVersionMigration** +> V1Status deleteStorageVersionMigration() + +delete a StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; +import type { StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + + +### Return type + +**V1Status** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **getAPIResources** +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**V1APIResourceList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **listStorageVersionMigration** +> V1beta1StorageVersionMigrationList listStorageVersionMigration() + +list or watch objects of kind StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; +import type { StoragemigrationV1beta1ApiListStorageVersionMigrationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiListStorageVersionMigrationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + + +### Return type + +**V1beta1StorageVersionMigrationList** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchStorageVersionMigration** +> V1beta1StorageVersionMigration patchStorageVersionMigration(body) + +partially update the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; +import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1StorageVersionMigration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **patchStorageVersionMigrationStatus** +> V1beta1StorageVersionMigration patchStorageVersionMigrationStatus(body) + +partially update status of the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; +import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersionMigrationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + + +### Return type + +**V1beta1StorageVersionMigration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readStorageVersionMigration** +> V1beta1StorageVersionMigration readStorageVersionMigration() + +read the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; +import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1StorageVersionMigration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **readStorageVersionMigrationStatus** +> V1beta1StorageVersionMigration readStorageVersionMigrationStatus() + +read status of the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; +import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest = { + // name of the StorageVersionMigration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersionMigrationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + + +### Return type + +**V1beta1StorageVersionMigration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceStorageVersionMigration** +> V1beta1StorageVersionMigration replaceStorageVersionMigration(body) + +replace the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; +import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + resource: { + group: "group_example", + resource: "resource_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + resourceVersion: "resourceVersion_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1StorageVersionMigration**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1StorageVersionMigration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **replaceStorageVersionMigrationStatus** +> V1beta1StorageVersionMigration replaceStorageVersionMigrationStatus(body) + +replace status of the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from ''; +import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest } from ''; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + resource: { + group: "group_example", + resource: "resource_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + resourceVersion: "resourceVersion_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersionMigrationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1StorageVersionMigration**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + + +### Return type + +**V1beta1StorageVersionMigration** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/VersionApi.md b/src/gen/docs/VersionApi.md new file mode 100644 index 0000000000..4c7dc72758 --- /dev/null +++ b/src/gen/docs/VersionApi.md @@ -0,0 +1,57 @@ +# .VersionApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getCode**](VersionApi.md#getCode) | **GET** /version/ | + + +# **getCode** +> VersionInfo getCode() + +get the version information for this server + +### Example + + +```typescript +import { createConfiguration, VersionApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new VersionApi(configuration); + +const request = {}; + +const data = await apiInstance.getCode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**VersionInfo** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/docs/WellKnownApi.md b/src/gen/docs/WellKnownApi.md new file mode 100644 index 0000000000..21eb99e5da --- /dev/null +++ b/src/gen/docs/WellKnownApi.md @@ -0,0 +1,57 @@ +# .WellKnownApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getServiceAccountIssuerOpenIDConfiguration**](WellKnownApi.md#getServiceAccountIssuerOpenIDConfiguration) | **GET** /.well-known/openid-configuration | + + +# **getServiceAccountIssuerOpenIDConfiguration** +> string getServiceAccountIssuerOpenIDConfiguration() + +get service account issuer OpenID configuration, also known as the \'OIDC discovery doc\' + +### Example + + +```typescript +import { createConfiguration, WellKnownApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new WellKnownApi(configuration); + +const request = {}; + +const data = await apiInstance.getServiceAccountIssuerOpenIDConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/src/gen/http/http.ts b/src/gen/http/http.ts index 3ea1ea692c..7be4c92d30 100644 --- a/src/gen/http/http.ts +++ b/src/gen/http/http.ts @@ -135,6 +135,13 @@ export class RequestContext { } public setHeaderParam(key: string, value: string): void { + // Delete any existing headers with case-insensitive matching keys + const lowerKey = key.toLowerCase(); + for (const existingKey in this.headers) { + if (existingKey.toLowerCase() === lowerKey) { + delete this.headers[existingKey]; + } + } this.headers[key] = value; } diff --git a/src/gen/tsconfig.json b/src/gen/tsconfig.json index 8df0d1a5bc..ca76aea1f9 100644 --- a/src/gen/tsconfig.json +++ b/src/gen/tsconfig.json @@ -6,6 +6,9 @@ "esModuleInterop": true, "moduleResolution": "node", "declaration": true, + "typeRoots": [ + "node_modules/@types" + ], /* Additional Checks */ "noUnusedLocals": false, /* Report errors on unused locals. */ // TODO: reenable (unused imports!) From 548061c8b7d5b284df719951c404de3dd7bee2d7 Mon Sep 17 00:00:00 2001 From: David Gamero Date: Tue, 6 Jan 2026 17:12:50 -0500 Subject: [PATCH 3/3] remove old generator docs --- src/gen/AdmissionregistrationApi.md | 57 - src/gen/AdmissionregistrationV1Api.md | 3762 -- src/gen/AdmissionregistrationV1alpha1Api.md | 1745 - src/gen/AdmissionregistrationV1beta1Api.md | 1745 - src/gen/ApiextensionsApi.md | 57 - src/gen/ApiextensionsV1Api.md | 1479 - src/gen/ApiregistrationApi.md | 57 - src/gen/ApiregistrationV1Api.md | 1026 - src/gen/ApisApi.md | 57 - src/gen/AppsApi.md | 57 - src/gen/AppsV1Api.md | 28117 ------------- src/gen/AuthenticationApi.md | 57 - src/gen/AuthenticationV1Api.md | 324 - src/gen/AuthenticationV1alpha1Api.md | 185 - src/gen/AuthenticationV1beta1Api.md | 185 - src/gen/AuthorizationApi.md | 57 - src/gen/AuthorizationV1Api.md | 704 - src/gen/AutoscalingApi.md | 57 - src/gen/AutoscalingV1Api.md | 1120 - src/gen/AutoscalingV2Api.md | 1828 - src/gen/BatchApi.md | 57 - src/gen/BatchV1Api.md | 13484 ------ src/gen/CertificatesApi.md | 57 - src/gen/CertificatesV1Api.md | 1326 - src/gen/CertificatesV1alpha1Api.md | 714 - src/gen/CertificatesV1beta1Api.md | 1819 - src/gen/CoordinationApi.md | 57 - src/gen/CoordinationV1Api.md | 830 - src/gen/CoordinationV1alpha2Api.md | 828 - src/gen/CoordinationV1beta1Api.md | 828 - src/gen/CoreApi.md | 57 - src/gen/CoreV1Api.md | 39216 ------------------ src/gen/CustomObjectsApi.md | 2230 - src/gen/DiscoveryApi.md | 57 - src/gen/DiscoveryV1Api.md | 908 - src/gen/EventsApi.md | 57 - src/gen/EventsV1Api.md | 884 - src/gen/FlowcontrolApiserverApi.md | 57 - src/gen/FlowcontrolApiserverV1Api.md | 2142 - src/gen/FlowcontrolApiserverV1beta3Api.md | 2126 - src/gen/InternalApiserverApi.md | 57 - src/gen/InternalApiserverV1alpha1Api.md | 1032 - src/gen/LogsApi.md | 108 - src/gen/NetworkingApi.md | 57 - src/gen/NetworkingV1Api.md | 4547 -- src/gen/NetworkingV1alpha1Api.md | 1654 - src/gen/NetworkingV1beta1Api.md | 1670 - src/gen/NodeApi.md | 57 - src/gen/NodeV1Api.md | 746 - src/gen/OpenidApi.md | 57 - src/gen/PolicyApi.md | 57 - src/gen/PolicyV1Api.md | 1186 - src/gen/README.md | 80 - src/gen/RbacAuthorizationApi.md | 57 - src/gen/RbacAuthorizationV1Api.md | 3029 -- src/gen/ResourceApi.md | 57 - src/gen/ResourceV1Api.md | 4238 -- src/gen/ResourceV1alpha2Api.md | 6145 --- src/gen/ResourceV1alpha3Api.md | 1029 - src/gen/ResourceV1beta1Api.md | 4232 -- src/gen/ResourceV1beta2Api.md | 4238 -- src/gen/SchedulingApi.md | 57 - src/gen/SchedulingV1Api.md | 714 - src/gen/SchedulingV1alpha1Api.md | 848 - src/gen/StorageApi.md | 57 - src/gen/StorageV1Api.md | 5303 --- src/gen/StorageV1alpha1Api.md | 714 - src/gen/StorageV1beta1Api.md | 714 - src/gen/StoragemigrationApi.md | 57 - src/gen/StoragemigrationV1alpha1Api.md | 1014 - src/gen/StoragemigrationV1beta1Api.md | 1011 - src/gen/VersionApi.md | 57 - src/gen/WellKnownApi.md | 57 - 73 files changed, 155346 deletions(-) delete mode 100644 src/gen/AdmissionregistrationApi.md delete mode 100644 src/gen/AdmissionregistrationV1Api.md delete mode 100644 src/gen/AdmissionregistrationV1alpha1Api.md delete mode 100644 src/gen/AdmissionregistrationV1beta1Api.md delete mode 100644 src/gen/ApiextensionsApi.md delete mode 100644 src/gen/ApiextensionsV1Api.md delete mode 100644 src/gen/ApiregistrationApi.md delete mode 100644 src/gen/ApiregistrationV1Api.md delete mode 100644 src/gen/ApisApi.md delete mode 100644 src/gen/AppsApi.md delete mode 100644 src/gen/AppsV1Api.md delete mode 100644 src/gen/AuthenticationApi.md delete mode 100644 src/gen/AuthenticationV1Api.md delete mode 100644 src/gen/AuthenticationV1alpha1Api.md delete mode 100644 src/gen/AuthenticationV1beta1Api.md delete mode 100644 src/gen/AuthorizationApi.md delete mode 100644 src/gen/AuthorizationV1Api.md delete mode 100644 src/gen/AutoscalingApi.md delete mode 100644 src/gen/AutoscalingV1Api.md delete mode 100644 src/gen/AutoscalingV2Api.md delete mode 100644 src/gen/BatchApi.md delete mode 100644 src/gen/BatchV1Api.md delete mode 100644 src/gen/CertificatesApi.md delete mode 100644 src/gen/CertificatesV1Api.md delete mode 100644 src/gen/CertificatesV1alpha1Api.md delete mode 100644 src/gen/CertificatesV1beta1Api.md delete mode 100644 src/gen/CoordinationApi.md delete mode 100644 src/gen/CoordinationV1Api.md delete mode 100644 src/gen/CoordinationV1alpha2Api.md delete mode 100644 src/gen/CoordinationV1beta1Api.md delete mode 100644 src/gen/CoreApi.md delete mode 100644 src/gen/CoreV1Api.md delete mode 100644 src/gen/CustomObjectsApi.md delete mode 100644 src/gen/DiscoveryApi.md delete mode 100644 src/gen/DiscoveryV1Api.md delete mode 100644 src/gen/EventsApi.md delete mode 100644 src/gen/EventsV1Api.md delete mode 100644 src/gen/FlowcontrolApiserverApi.md delete mode 100644 src/gen/FlowcontrolApiserverV1Api.md delete mode 100644 src/gen/FlowcontrolApiserverV1beta3Api.md delete mode 100644 src/gen/InternalApiserverApi.md delete mode 100644 src/gen/InternalApiserverV1alpha1Api.md delete mode 100644 src/gen/LogsApi.md delete mode 100644 src/gen/NetworkingApi.md delete mode 100644 src/gen/NetworkingV1Api.md delete mode 100644 src/gen/NetworkingV1alpha1Api.md delete mode 100644 src/gen/NetworkingV1beta1Api.md delete mode 100644 src/gen/NodeApi.md delete mode 100644 src/gen/NodeV1Api.md delete mode 100644 src/gen/OpenidApi.md delete mode 100644 src/gen/PolicyApi.md delete mode 100644 src/gen/PolicyV1Api.md delete mode 100644 src/gen/README.md delete mode 100644 src/gen/RbacAuthorizationApi.md delete mode 100644 src/gen/RbacAuthorizationV1Api.md delete mode 100644 src/gen/ResourceApi.md delete mode 100644 src/gen/ResourceV1Api.md delete mode 100644 src/gen/ResourceV1alpha2Api.md delete mode 100644 src/gen/ResourceV1alpha3Api.md delete mode 100644 src/gen/ResourceV1beta1Api.md delete mode 100644 src/gen/ResourceV1beta2Api.md delete mode 100644 src/gen/SchedulingApi.md delete mode 100644 src/gen/SchedulingV1Api.md delete mode 100644 src/gen/SchedulingV1alpha1Api.md delete mode 100644 src/gen/StorageApi.md delete mode 100644 src/gen/StorageV1Api.md delete mode 100644 src/gen/StorageV1alpha1Api.md delete mode 100644 src/gen/StorageV1beta1Api.md delete mode 100644 src/gen/StoragemigrationApi.md delete mode 100644 src/gen/StoragemigrationV1alpha1Api.md delete mode 100644 src/gen/StoragemigrationV1beta1Api.md delete mode 100644 src/gen/VersionApi.md delete mode 100644 src/gen/WellKnownApi.md diff --git a/src/gen/AdmissionregistrationApi.md b/src/gen/AdmissionregistrationApi.md deleted file mode 100644 index fdf3930721..0000000000 --- a/src/gen/AdmissionregistrationApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .AdmissionregistrationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](AdmissionregistrationApi.md#getAPIGroup) | **GET** /apis/admissionregistration.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AdmissionregistrationV1Api.md b/src/gen/AdmissionregistrationV1Api.md deleted file mode 100644 index 75db144deb..0000000000 --- a/src/gen/AdmissionregistrationV1Api.md +++ /dev/null @@ -1,3762 +0,0 @@ -# .AdmissionregistrationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#createMutatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | -[**createValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#createValidatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | -[**createValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#createValidatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | -[**createValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#createValidatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | -[**deleteCollectionMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#deleteCollectionMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | -[**deleteCollectionValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#deleteCollectionValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | -[**deleteCollectionValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#deleteCollectionValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | -[**deleteCollectionValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#deleteCollectionValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | -[**deleteMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#deleteMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**deleteValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#deleteValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**deleteValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#deleteValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**deleteValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#deleteValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | -[**getAPIResources**](AdmissionregistrationV1Api.md#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1/ | -[**listMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#listMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | -[**listValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#listValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | -[**listValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#listValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | -[**listValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#listValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | -[**patchMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#patchMutatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**patchValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#patchValidatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**patchValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#patchValidatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**patchValidatingAdmissionPolicyStatus**](AdmissionregistrationV1Api.md#patchValidatingAdmissionPolicyStatus) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | -[**patchValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#patchValidatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | -[**readMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#readMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**readValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#readValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**readValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#readValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**readValidatingAdmissionPolicyStatus**](AdmissionregistrationV1Api.md#readValidatingAdmissionPolicyStatus) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | -[**readValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#readValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | -[**replaceMutatingWebhookConfiguration**](AdmissionregistrationV1Api.md#replaceMutatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**replaceValidatingAdmissionPolicy**](AdmissionregistrationV1Api.md#replaceValidatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**replaceValidatingAdmissionPolicyBinding**](AdmissionregistrationV1Api.md#replaceValidatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**replaceValidatingAdmissionPolicyStatus**](AdmissionregistrationV1Api.md#replaceValidatingAdmissionPolicyStatus) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | -[**replaceValidatingWebhookConfiguration**](AdmissionregistrationV1Api.md#replaceValidatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | - - -# **createMutatingWebhookConfiguration** -> V1MutatingWebhookConfiguration createMutatingWebhookConfiguration(body) - -create a MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - reinvocationPolicy: "reinvocationPolicy_example", - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1MutatingWebhookConfiguration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1MutatingWebhookConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createValidatingAdmissionPolicy** -> V1ValidatingAdmissionPolicy createValidatingAdmissionPolicy(body) - -create a ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - auditAnnotations: [ - { - key: "key_example", - valueExpression: "valueExpression_example", - }, - ], - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - validations: [ - { - expression: "expression_example", - message: "message_example", - messageExpression: "messageExpression_example", - reason: "reason_example", - }, - ], - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - typeChecking: { - expressionWarnings: [ - { - fieldRef: "fieldRef_example", - warning: "warning_example", - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicy**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createValidatingAdmissionPolicyBinding** -> V1ValidatingAdmissionPolicyBinding createValidatingAdmissionPolicyBinding(body) - -create a ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - validationActions: [ - "validationActions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicyBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createValidatingWebhookConfiguration** -> V1ValidatingWebhookConfiguration createValidatingWebhookConfiguration(body) - -create a ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingWebhookConfiguration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingWebhookConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionMutatingWebhookConfiguration** -> V1Status deleteCollectionMutatingWebhookConfiguration() - -delete collection of MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionValidatingAdmissionPolicy** -> V1Status deleteCollectionValidatingAdmissionPolicy() - -delete collection of ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionValidatingAdmissionPolicyBinding** -> V1Status deleteCollectionValidatingAdmissionPolicyBinding() - -delete collection of ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionValidatingWebhookConfiguration** -> V1Status deleteCollectionValidatingWebhookConfiguration() - -delete collection of ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteMutatingWebhookConfiguration** -> V1Status deleteMutatingWebhookConfiguration() - -delete a MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteValidatingAdmissionPolicy** -> V1Status deleteValidatingAdmissionPolicy() - -delete a ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteValidatingAdmissionPolicyBinding** -> V1Status deleteValidatingAdmissionPolicyBinding() - -delete a ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteValidatingWebhookConfiguration** -> V1Status deleteValidatingWebhookConfiguration() - -delete a ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listMutatingWebhookConfiguration** -> V1MutatingWebhookConfigurationList listMutatingWebhookConfiguration() - -list or watch objects of kind MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1MutatingWebhookConfigurationList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listValidatingAdmissionPolicy** -> V1ValidatingAdmissionPolicyList listValidatingAdmissionPolicy() - -list or watch objects of kind ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicyList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listValidatingAdmissionPolicyBinding** -> V1ValidatingAdmissionPolicyBindingList listValidatingAdmissionPolicyBinding() - -list or watch objects of kind ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicyBindingList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listValidatingWebhookConfiguration** -> V1ValidatingWebhookConfigurationList listValidatingWebhookConfiguration() - -list or watch objects of kind ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingWebhookConfigurationList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchMutatingWebhookConfiguration** -> V1MutatingWebhookConfiguration patchMutatingWebhookConfiguration(body) - -partially update the specified MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1MutatingWebhookConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchValidatingAdmissionPolicy** -> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicy(body) - -partially update the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchValidatingAdmissionPolicyBinding** -> V1ValidatingAdmissionPolicyBinding patchValidatingAdmissionPolicyBinding(body) - -partially update the specified ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchValidatingAdmissionPolicyStatus** -> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicyStatus(body) - -partially update status of the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingAdmissionPolicyStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchValidatingWebhookConfiguration** -> V1ValidatingWebhookConfiguration patchValidatingWebhookConfiguration(body) - -partially update the specified ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingWebhookConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readMutatingWebhookConfiguration** -> V1MutatingWebhookConfiguration readMutatingWebhookConfiguration() - -read the specified MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1MutatingWebhookConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readValidatingAdmissionPolicy** -> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicy() - -read the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readValidatingAdmissionPolicyBinding** -> V1ValidatingAdmissionPolicyBinding readValidatingAdmissionPolicyBinding() - -read the specified ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readValidatingAdmissionPolicyStatus** -> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicyStatus() - -read status of the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingAdmissionPolicyStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readValidatingWebhookConfiguration** -> V1ValidatingWebhookConfiguration readValidatingWebhookConfiguration() - -read the specified ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ValidatingWebhookConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceMutatingWebhookConfiguration** -> V1MutatingWebhookConfiguration replaceMutatingWebhookConfiguration(body) - -replace the specified MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - reinvocationPolicy: "reinvocationPolicy_example", - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1MutatingWebhookConfiguration**| | - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1MutatingWebhookConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceValidatingAdmissionPolicy** -> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicy(body) - -replace the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - auditAnnotations: [ - { - key: "key_example", - valueExpression: "valueExpression_example", - }, - ], - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - validations: [ - { - expression: "expression_example", - message: "message_example", - messageExpression: "messageExpression_example", - reason: "reason_example", - }, - ], - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - typeChecking: { - expressionWarnings: [ - { - fieldRef: "fieldRef_example", - warning: "warning_example", - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicy**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceValidatingAdmissionPolicyBinding** -> V1ValidatingAdmissionPolicyBinding replaceValidatingAdmissionPolicyBinding(body) - -replace the specified ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - validationActions: [ - "validationActions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicyBinding**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceValidatingAdmissionPolicyStatus** -> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicyStatus(body) - -replace status of the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - auditAnnotations: [ - { - key: "key_example", - valueExpression: "valueExpression_example", - }, - ], - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - validations: [ - { - expression: "expression_example", - message: "message_example", - messageExpression: "messageExpression_example", - reason: "reason_example", - }, - ], - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - typeChecking: { - expressionWarnings: [ - { - fieldRef: "fieldRef_example", - warning: "warning_example", - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingAdmissionPolicyStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicy**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceValidatingWebhookConfiguration** -> V1ValidatingWebhookConfiguration replaceValidatingWebhookConfiguration(body) - -replace the specified ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from ''; -import type { AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingWebhookConfiguration**| | - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ValidatingWebhookConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AdmissionregistrationV1alpha1Api.md b/src/gen/AdmissionregistrationV1alpha1Api.md deleted file mode 100644 index e256036b3b..0000000000 --- a/src/gen/AdmissionregistrationV1alpha1Api.md +++ /dev/null @@ -1,1745 +0,0 @@ -# .AdmissionregistrationV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | -[**createMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | -[**deleteCollectionMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | -[**deleteCollectionMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | -[**deleteMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**deleteMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | -[**getAPIResources**](AdmissionregistrationV1alpha1Api.md#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/ | -[**listMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | -[**listMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | -[**patchMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**patchMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | -[**readMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**readMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | -[**replaceMutatingAdmissionPolicy**](AdmissionregistrationV1alpha1Api.md#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**replaceMutatingAdmissionPolicyBinding**](AdmissionregistrationV1alpha1Api.md#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | - - -# **createMutatingAdmissionPolicy** -> V1alpha1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) - -create a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicy**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1MutatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createMutatingAdmissionPolicyBinding** -> V1alpha1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) - -create a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1MutatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionMutatingAdmissionPolicy** -> V1Status deleteCollectionMutatingAdmissionPolicy() - -delete collection of MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionMutatingAdmissionPolicyBinding** -> V1Status deleteCollectionMutatingAdmissionPolicyBinding() - -delete collection of MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteMutatingAdmissionPolicy** -> V1Status deleteMutatingAdmissionPolicy() - -delete a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteMutatingAdmissionPolicyBinding** -> V1Status deleteMutatingAdmissionPolicyBinding() - -delete a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listMutatingAdmissionPolicy** -> V1alpha1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() - -list or watch objects of kind MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha1MutatingAdmissionPolicyList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listMutatingAdmissionPolicyBinding** -> V1alpha1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() - -list or watch objects of kind MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha1MutatingAdmissionPolicyBindingList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchMutatingAdmissionPolicy** -> V1alpha1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) - -partially update the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1MutatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchMutatingAdmissionPolicyBinding** -> V1alpha1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) - -partially update the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1MutatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readMutatingAdmissionPolicy** -> V1alpha1MutatingAdmissionPolicy readMutatingAdmissionPolicy() - -read the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1MutatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readMutatingAdmissionPolicyBinding** -> V1alpha1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() - -read the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1MutatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceMutatingAdmissionPolicy** -> V1alpha1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) - -replace the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicy**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1MutatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceMutatingAdmissionPolicyBinding** -> V1alpha1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) - -replace the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from ''; -import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1MutatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AdmissionregistrationV1beta1Api.md b/src/gen/AdmissionregistrationV1beta1Api.md deleted file mode 100644 index 41b35289ea..0000000000 --- a/src/gen/AdmissionregistrationV1beta1Api.md +++ /dev/null @@ -1,1745 +0,0 @@ -# .AdmissionregistrationV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | -[**createMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | -[**deleteCollectionMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | -[**deleteCollectionMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | -[**deleteMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**deleteMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | -[**getAPIResources**](AdmissionregistrationV1beta1Api.md#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1beta1/ | -[**listMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | -[**listMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | -[**patchMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**patchMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | -[**readMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**readMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | -[**replaceMutatingAdmissionPolicy**](AdmissionregistrationV1beta1Api.md#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**replaceMutatingAdmissionPolicyBinding**](AdmissionregistrationV1beta1Api.md#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | - - -# **createMutatingAdmissionPolicy** -> V1beta1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) - -create a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicy**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1MutatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createMutatingAdmissionPolicyBinding** -> V1beta1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) - -create a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicyBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1MutatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionMutatingAdmissionPolicy** -> V1Status deleteCollectionMutatingAdmissionPolicy() - -delete collection of MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionMutatingAdmissionPolicyBinding** -> V1Status deleteCollectionMutatingAdmissionPolicyBinding() - -delete collection of MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteMutatingAdmissionPolicy** -> V1Status deleteMutatingAdmissionPolicy() - -delete a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteMutatingAdmissionPolicyBinding** -> V1Status deleteMutatingAdmissionPolicyBinding() - -delete a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listMutatingAdmissionPolicy** -> V1beta1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() - -list or watch objects of kind MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1MutatingAdmissionPolicyList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listMutatingAdmissionPolicyBinding** -> V1beta1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() - -list or watch objects of kind MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1MutatingAdmissionPolicyBindingList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchMutatingAdmissionPolicy** -> V1beta1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) - -partially update the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1MutatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchMutatingAdmissionPolicyBinding** -> V1beta1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) - -partially update the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1MutatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readMutatingAdmissionPolicy** -> V1beta1MutatingAdmissionPolicy readMutatingAdmissionPolicy() - -read the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1MutatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readMutatingAdmissionPolicyBinding** -> V1beta1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() - -read the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1MutatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceMutatingAdmissionPolicy** -> V1beta1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) - -replace the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicy**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1MutatingAdmissionPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceMutatingAdmissionPolicyBinding** -> V1beta1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) - -replace the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from ''; -import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicyBinding**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1MutatingAdmissionPolicyBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ApiextensionsApi.md b/src/gen/ApiextensionsApi.md deleted file mode 100644 index 14d9d5ba49..0000000000 --- a/src/gen/ApiextensionsApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .ApiextensionsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](ApiextensionsApi.md#getAPIGroup) | **GET** /apis/apiextensions.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, ApiextensionsApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ApiextensionsV1Api.md b/src/gen/ApiextensionsV1Api.md deleted file mode 100644 index 1547e08d2d..0000000000 --- a/src/gen/ApiextensionsV1Api.md +++ /dev/null @@ -1,1479 +0,0 @@ -# .ApiextensionsV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createCustomResourceDefinition**](ApiextensionsV1Api.md#createCustomResourceDefinition) | **POST** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | -[**deleteCollectionCustomResourceDefinition**](ApiextensionsV1Api.md#deleteCollectionCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | -[**deleteCustomResourceDefinition**](ApiextensionsV1Api.md#deleteCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**getAPIResources**](ApiextensionsV1Api.md#getAPIResources) | **GET** /apis/apiextensions.k8s.io/v1/ | -[**listCustomResourceDefinition**](ApiextensionsV1Api.md#listCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | -[**patchCustomResourceDefinition**](ApiextensionsV1Api.md#patchCustomResourceDefinition) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**patchCustomResourceDefinitionStatus**](ApiextensionsV1Api.md#patchCustomResourceDefinitionStatus) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | -[**readCustomResourceDefinition**](ApiextensionsV1Api.md#readCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**readCustomResourceDefinitionStatus**](ApiextensionsV1Api.md#readCustomResourceDefinitionStatus) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | -[**replaceCustomResourceDefinition**](ApiextensionsV1Api.md#replaceCustomResourceDefinition) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**replaceCustomResourceDefinitionStatus**](ApiextensionsV1Api.md#replaceCustomResourceDefinitionStatus) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | - - -# **createCustomResourceDefinition** -> V1CustomResourceDefinition createCustomResourceDefinition(body) - -create a CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; -import type { ApiextensionsV1ApiCreateCustomResourceDefinitionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiCreateCustomResourceDefinitionRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - conversion: { - strategy: "strategy_example", - webhook: { - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - conversionReviewVersions: [ - "conversionReviewVersions_example", - ], - }, - }, - group: "group_example", - names: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - preserveUnknownFields: true, - scope: "scope_example", - versions: [ - { - additionalPrinterColumns: [ - { - description: "description_example", - format: "format_example", - jsonPath: "jsonPath_example", - name: "name_example", - priority: 1, - type: "type_example", - }, - ], - deprecated: true, - deprecationWarning: "deprecationWarning_example", - name: "name_example", - schema: { - openAPIV3Schema: { - ref: "ref_example", - schema: "schema_example", - additionalItems: {}, - additionalProperties: {}, - allOf: [ - , - ], - anyOf: [ - , - ], - _default: {}, - definitions: { - "key": , - }, - dependencies: { - "key": {}, - }, - description: "description_example", - _enum: [ - {}, - ], - example: {}, - exclusiveMaximum: true, - exclusiveMinimum: true, - externalDocs: { - description: "description_example", - url: "url_example", - }, - format: "format_example", - id: "id_example", - items: {}, - maxItems: 1, - maxLength: 1, - maxProperties: 1, - maximum: 3.14, - minItems: 1, - minLength: 1, - minProperties: 1, - minimum: 3.14, - multipleOf: 3.14, - not: , - nullable: true, - oneOf: [ - , - ], - pattern: "pattern_example", - patternProperties: { - "key": , - }, - properties: { - "key": , - }, - required: [ - "required_example", - ], - title: "title_example", - type: "type_example", - uniqueItems: true, - x_kubernetes_embedded_resource: true, - x_kubernetes_int_or_string: true, - x_kubernetes_list_map_keys: [ - "x_kubernetes_list_map_keys_example", - ], - x_kubernetes_list_type: "x_kubernetes_list_type_example", - x_kubernetes_map_type: "x_kubernetes_map_type_example", - x_kubernetes_preserve_unknown_fields: true, - x_kubernetes_validations: [ - { - fieldPath: "fieldPath_example", - message: "message_example", - messageExpression: "messageExpression_example", - optionalOldSelf: true, - reason: "reason_example", - rule: "rule_example", - }, - ], - }, - }, - selectableFields: [ - { - jsonPath: "jsonPath_example", - }, - ], - served: true, - storage: true, - subresources: { - scale: { - labelSelectorPath: "labelSelectorPath_example", - specReplicasPath: "specReplicasPath_example", - statusReplicasPath: "statusReplicasPath_example", - }, - status: {}, - }, - }, - ], - }, - status: { - acceptedNames: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - storedVersions: [ - "storedVersions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CustomResourceDefinition**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CustomResourceDefinition** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionCustomResourceDefinition** -> V1Status deleteCollectionCustomResourceDefinition() - -delete collection of CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; -import type { ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCustomResourceDefinition** -> V1Status deleteCustomResourceDefinition() - -delete a CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; -import type { ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listCustomResourceDefinition** -> V1CustomResourceDefinitionList listCustomResourceDefinition() - -list or watch objects of kind CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; -import type { ApiextensionsV1ApiListCustomResourceDefinitionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiListCustomResourceDefinitionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1CustomResourceDefinitionList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchCustomResourceDefinition** -> V1CustomResourceDefinition patchCustomResourceDefinition(body) - -partially update the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; -import type { ApiextensionsV1ApiPatchCustomResourceDefinitionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiPatchCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1CustomResourceDefinition** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchCustomResourceDefinitionStatus** -> V1CustomResourceDefinition patchCustomResourceDefinitionStatus(body) - -partially update status of the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; -import type { ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCustomResourceDefinitionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1CustomResourceDefinition** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readCustomResourceDefinition** -> V1CustomResourceDefinition readCustomResourceDefinition() - -read the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; -import type { ApiextensionsV1ApiReadCustomResourceDefinitionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReadCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1CustomResourceDefinition** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readCustomResourceDefinitionStatus** -> V1CustomResourceDefinition readCustomResourceDefinitionStatus() - -read status of the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; -import type { ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest = { - // name of the CustomResourceDefinition - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCustomResourceDefinitionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1CustomResourceDefinition** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceCustomResourceDefinition** -> V1CustomResourceDefinition replaceCustomResourceDefinition(body) - -replace the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; -import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - conversion: { - strategy: "strategy_example", - webhook: { - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - conversionReviewVersions: [ - "conversionReviewVersions_example", - ], - }, - }, - group: "group_example", - names: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - preserveUnknownFields: true, - scope: "scope_example", - versions: [ - { - additionalPrinterColumns: [ - { - description: "description_example", - format: "format_example", - jsonPath: "jsonPath_example", - name: "name_example", - priority: 1, - type: "type_example", - }, - ], - deprecated: true, - deprecationWarning: "deprecationWarning_example", - name: "name_example", - schema: { - openAPIV3Schema: { - ref: "ref_example", - schema: "schema_example", - additionalItems: {}, - additionalProperties: {}, - allOf: [ - , - ], - anyOf: [ - , - ], - _default: {}, - definitions: { - "key": , - }, - dependencies: { - "key": {}, - }, - description: "description_example", - _enum: [ - {}, - ], - example: {}, - exclusiveMaximum: true, - exclusiveMinimum: true, - externalDocs: { - description: "description_example", - url: "url_example", - }, - format: "format_example", - id: "id_example", - items: {}, - maxItems: 1, - maxLength: 1, - maxProperties: 1, - maximum: 3.14, - minItems: 1, - minLength: 1, - minProperties: 1, - minimum: 3.14, - multipleOf: 3.14, - not: , - nullable: true, - oneOf: [ - , - ], - pattern: "pattern_example", - patternProperties: { - "key": , - }, - properties: { - "key": , - }, - required: [ - "required_example", - ], - title: "title_example", - type: "type_example", - uniqueItems: true, - x_kubernetes_embedded_resource: true, - x_kubernetes_int_or_string: true, - x_kubernetes_list_map_keys: [ - "x_kubernetes_list_map_keys_example", - ], - x_kubernetes_list_type: "x_kubernetes_list_type_example", - x_kubernetes_map_type: "x_kubernetes_map_type_example", - x_kubernetes_preserve_unknown_fields: true, - x_kubernetes_validations: [ - { - fieldPath: "fieldPath_example", - message: "message_example", - messageExpression: "messageExpression_example", - optionalOldSelf: true, - reason: "reason_example", - rule: "rule_example", - }, - ], - }, - }, - selectableFields: [ - { - jsonPath: "jsonPath_example", - }, - ], - served: true, - storage: true, - subresources: { - scale: { - labelSelectorPath: "labelSelectorPath_example", - specReplicasPath: "specReplicasPath_example", - statusReplicasPath: "statusReplicasPath_example", - }, - status: {}, - }, - }, - ], - }, - status: { - acceptedNames: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - storedVersions: [ - "storedVersions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CustomResourceDefinition**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CustomResourceDefinition** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceCustomResourceDefinitionStatus** -> V1CustomResourceDefinition replaceCustomResourceDefinitionStatus(body) - -replace status of the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from ''; -import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - conversion: { - strategy: "strategy_example", - webhook: { - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - conversionReviewVersions: [ - "conversionReviewVersions_example", - ], - }, - }, - group: "group_example", - names: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - preserveUnknownFields: true, - scope: "scope_example", - versions: [ - { - additionalPrinterColumns: [ - { - description: "description_example", - format: "format_example", - jsonPath: "jsonPath_example", - name: "name_example", - priority: 1, - type: "type_example", - }, - ], - deprecated: true, - deprecationWarning: "deprecationWarning_example", - name: "name_example", - schema: { - openAPIV3Schema: { - ref: "ref_example", - schema: "schema_example", - additionalItems: {}, - additionalProperties: {}, - allOf: [ - , - ], - anyOf: [ - , - ], - _default: {}, - definitions: { - "key": , - }, - dependencies: { - "key": {}, - }, - description: "description_example", - _enum: [ - {}, - ], - example: {}, - exclusiveMaximum: true, - exclusiveMinimum: true, - externalDocs: { - description: "description_example", - url: "url_example", - }, - format: "format_example", - id: "id_example", - items: {}, - maxItems: 1, - maxLength: 1, - maxProperties: 1, - maximum: 3.14, - minItems: 1, - minLength: 1, - minProperties: 1, - minimum: 3.14, - multipleOf: 3.14, - not: , - nullable: true, - oneOf: [ - , - ], - pattern: "pattern_example", - patternProperties: { - "key": , - }, - properties: { - "key": , - }, - required: [ - "required_example", - ], - title: "title_example", - type: "type_example", - uniqueItems: true, - x_kubernetes_embedded_resource: true, - x_kubernetes_int_or_string: true, - x_kubernetes_list_map_keys: [ - "x_kubernetes_list_map_keys_example", - ], - x_kubernetes_list_type: "x_kubernetes_list_type_example", - x_kubernetes_map_type: "x_kubernetes_map_type_example", - x_kubernetes_preserve_unknown_fields: true, - x_kubernetes_validations: [ - { - fieldPath: "fieldPath_example", - message: "message_example", - messageExpression: "messageExpression_example", - optionalOldSelf: true, - reason: "reason_example", - rule: "rule_example", - }, - ], - }, - }, - selectableFields: [ - { - jsonPath: "jsonPath_example", - }, - ], - served: true, - storage: true, - subresources: { - scale: { - labelSelectorPath: "labelSelectorPath_example", - specReplicasPath: "specReplicasPath_example", - statusReplicasPath: "statusReplicasPath_example", - }, - status: {}, - }, - }, - ], - }, - status: { - acceptedNames: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - storedVersions: [ - "storedVersions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCustomResourceDefinitionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CustomResourceDefinition**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CustomResourceDefinition** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ApiregistrationApi.md b/src/gen/ApiregistrationApi.md deleted file mode 100644 index 4eadbdb578..0000000000 --- a/src/gen/ApiregistrationApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .ApiregistrationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](ApiregistrationApi.md#getAPIGroup) | **GET** /apis/apiregistration.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, ApiregistrationApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ApiregistrationV1Api.md b/src/gen/ApiregistrationV1Api.md deleted file mode 100644 index 12530bc672..0000000000 --- a/src/gen/ApiregistrationV1Api.md +++ /dev/null @@ -1,1026 +0,0 @@ -# .ApiregistrationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createAPIService**](ApiregistrationV1Api.md#createAPIService) | **POST** /apis/apiregistration.k8s.io/v1/apiservices | -[**deleteAPIService**](ApiregistrationV1Api.md#deleteAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**deleteCollectionAPIService**](ApiregistrationV1Api.md#deleteCollectionAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices | -[**getAPIResources**](ApiregistrationV1Api.md#getAPIResources) | **GET** /apis/apiregistration.k8s.io/v1/ | -[**listAPIService**](ApiregistrationV1Api.md#listAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices | -[**patchAPIService**](ApiregistrationV1Api.md#patchAPIService) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**patchAPIServiceStatus**](ApiregistrationV1Api.md#patchAPIServiceStatus) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | -[**readAPIService**](ApiregistrationV1Api.md#readAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**readAPIServiceStatus**](ApiregistrationV1Api.md#readAPIServiceStatus) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | -[**replaceAPIService**](ApiregistrationV1Api.md#replaceAPIService) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**replaceAPIServiceStatus**](ApiregistrationV1Api.md#replaceAPIServiceStatus) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | - - -# **createAPIService** -> V1APIService createAPIService(body) - -create an APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; -import type { ApiregistrationV1ApiCreateAPIServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiCreateAPIServiceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - caBundle: 'YQ==', - group: "group_example", - groupPriorityMinimum: 1, - insecureSkipTLSVerify: true, - service: { - name: "name_example", - namespace: "namespace_example", - port: 1, - }, - version: "version_example", - versionPriority: 1, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1APIService**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1APIService** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteAPIService** -> V1Status deleteAPIService() - -delete an APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; -import type { ApiregistrationV1ApiDeleteAPIServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiDeleteAPIServiceRequest = { - // name of the APIService - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionAPIService** -> V1Status deleteCollectionAPIService() - -delete collection of APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; -import type { ApiregistrationV1ApiDeleteCollectionAPIServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiDeleteCollectionAPIServiceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listAPIService** -> V1APIServiceList listAPIService() - -list or watch objects of kind APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; -import type { ApiregistrationV1ApiListAPIServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiListAPIServiceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1APIServiceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchAPIService** -> V1APIService patchAPIService(body) - -partially update the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; -import type { ApiregistrationV1ApiPatchAPIServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiPatchAPIServiceRequest = { - // name of the APIService - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1APIService** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchAPIServiceStatus** -> V1APIService patchAPIServiceStatus(body) - -partially update status of the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; -import type { ApiregistrationV1ApiPatchAPIServiceStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiPatchAPIServiceStatusRequest = { - // name of the APIService - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchAPIServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1APIService** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readAPIService** -> V1APIService readAPIService() - -read the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; -import type { ApiregistrationV1ApiReadAPIServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReadAPIServiceRequest = { - // name of the APIService - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1APIService** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readAPIServiceStatus** -> V1APIService readAPIServiceStatus() - -read status of the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; -import type { ApiregistrationV1ApiReadAPIServiceStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReadAPIServiceStatusRequest = { - // name of the APIService - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readAPIServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1APIService** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceAPIService** -> V1APIService replaceAPIService(body) - -replace the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; -import type { ApiregistrationV1ApiReplaceAPIServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReplaceAPIServiceRequest = { - // name of the APIService - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - caBundle: 'YQ==', - group: "group_example", - groupPriorityMinimum: 1, - insecureSkipTLSVerify: true, - service: { - name: "name_example", - namespace: "namespace_example", - port: 1, - }, - version: "version_example", - versionPriority: 1, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1APIService**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1APIService** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceAPIServiceStatus** -> V1APIService replaceAPIServiceStatus(body) - -replace status of the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from ''; -import type { ApiregistrationV1ApiReplaceAPIServiceStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReplaceAPIServiceStatusRequest = { - // name of the APIService - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - caBundle: 'YQ==', - group: "group_example", - groupPriorityMinimum: 1, - insecureSkipTLSVerify: true, - service: { - name: "name_example", - namespace: "namespace_example", - port: 1, - }, - version: "version_example", - versionPriority: 1, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceAPIServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1APIService**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1APIService** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ApisApi.md b/src/gen/ApisApi.md deleted file mode 100644 index d7ffff7a76..0000000000 --- a/src/gen/ApisApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .ApisApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIVersions**](ApisApi.md#getAPIVersions) | **GET** /apis/ | - - -# **getAPIVersions** -> V1APIGroupList getAPIVersions() - -get available API versions - -### Example - - -```typescript -import { createConfiguration, ApisApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ApisApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIVersions(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroupList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AppsApi.md b/src/gen/AppsApi.md deleted file mode 100644 index cbf30ffb12..0000000000 --- a/src/gen/AppsApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .AppsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](AppsApi.md#getAPIGroup) | **GET** /apis/apps/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AppsApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AppsV1Api.md b/src/gen/AppsV1Api.md deleted file mode 100644 index 96ce980868..0000000000 --- a/src/gen/AppsV1Api.md +++ /dev/null @@ -1,28117 +0,0 @@ -# .AppsV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedControllerRevision**](AppsV1Api.md#createNamespacedControllerRevision) | **POST** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | -[**createNamespacedDaemonSet**](AppsV1Api.md#createNamespacedDaemonSet) | **POST** /apis/apps/v1/namespaces/{namespace}/daemonsets | -[**createNamespacedDeployment**](AppsV1Api.md#createNamespacedDeployment) | **POST** /apis/apps/v1/namespaces/{namespace}/deployments | -[**createNamespacedReplicaSet**](AppsV1Api.md#createNamespacedReplicaSet) | **POST** /apis/apps/v1/namespaces/{namespace}/replicasets | -[**createNamespacedStatefulSet**](AppsV1Api.md#createNamespacedStatefulSet) | **POST** /apis/apps/v1/namespaces/{namespace}/statefulsets | -[**deleteCollectionNamespacedControllerRevision**](AppsV1Api.md#deleteCollectionNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | -[**deleteCollectionNamespacedDaemonSet**](AppsV1Api.md#deleteCollectionNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets | -[**deleteCollectionNamespacedDeployment**](AppsV1Api.md#deleteCollectionNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments | -[**deleteCollectionNamespacedReplicaSet**](AppsV1Api.md#deleteCollectionNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets | -[**deleteCollectionNamespacedStatefulSet**](AppsV1Api.md#deleteCollectionNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets | -[**deleteNamespacedControllerRevision**](AppsV1Api.md#deleteNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**deleteNamespacedDaemonSet**](AppsV1Api.md#deleteNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**deleteNamespacedDeployment**](AppsV1Api.md#deleteNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**deleteNamespacedReplicaSet**](AppsV1Api.md#deleteNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**deleteNamespacedStatefulSet**](AppsV1Api.md#deleteNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**getAPIResources**](AppsV1Api.md#getAPIResources) | **GET** /apis/apps/v1/ | -[**listControllerRevisionForAllNamespaces**](AppsV1Api.md#listControllerRevisionForAllNamespaces) | **GET** /apis/apps/v1/controllerrevisions | -[**listDaemonSetForAllNamespaces**](AppsV1Api.md#listDaemonSetForAllNamespaces) | **GET** /apis/apps/v1/daemonsets | -[**listDeploymentForAllNamespaces**](AppsV1Api.md#listDeploymentForAllNamespaces) | **GET** /apis/apps/v1/deployments | -[**listNamespacedControllerRevision**](AppsV1Api.md#listNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | -[**listNamespacedDaemonSet**](AppsV1Api.md#listNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets | -[**listNamespacedDeployment**](AppsV1Api.md#listNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments | -[**listNamespacedReplicaSet**](AppsV1Api.md#listNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets | -[**listNamespacedStatefulSet**](AppsV1Api.md#listNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets | -[**listReplicaSetForAllNamespaces**](AppsV1Api.md#listReplicaSetForAllNamespaces) | **GET** /apis/apps/v1/replicasets | -[**listStatefulSetForAllNamespaces**](AppsV1Api.md#listStatefulSetForAllNamespaces) | **GET** /apis/apps/v1/statefulsets | -[**patchNamespacedControllerRevision**](AppsV1Api.md#patchNamespacedControllerRevision) | **PATCH** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**patchNamespacedDaemonSet**](AppsV1Api.md#patchNamespacedDaemonSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**patchNamespacedDaemonSetStatus**](AppsV1Api.md#patchNamespacedDaemonSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | -[**patchNamespacedDeployment**](AppsV1Api.md#patchNamespacedDeployment) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**patchNamespacedDeploymentScale**](AppsV1Api.md#patchNamespacedDeploymentScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | -[**patchNamespacedDeploymentStatus**](AppsV1Api.md#patchNamespacedDeploymentStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | -[**patchNamespacedReplicaSet**](AppsV1Api.md#patchNamespacedReplicaSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**patchNamespacedReplicaSetScale**](AppsV1Api.md#patchNamespacedReplicaSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | -[**patchNamespacedReplicaSetStatus**](AppsV1Api.md#patchNamespacedReplicaSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | -[**patchNamespacedStatefulSet**](AppsV1Api.md#patchNamespacedStatefulSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**patchNamespacedStatefulSetScale**](AppsV1Api.md#patchNamespacedStatefulSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | -[**patchNamespacedStatefulSetStatus**](AppsV1Api.md#patchNamespacedStatefulSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | -[**readNamespacedControllerRevision**](AppsV1Api.md#readNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**readNamespacedDaemonSet**](AppsV1Api.md#readNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**readNamespacedDaemonSetStatus**](AppsV1Api.md#readNamespacedDaemonSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | -[**readNamespacedDeployment**](AppsV1Api.md#readNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**readNamespacedDeploymentScale**](AppsV1Api.md#readNamespacedDeploymentScale) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | -[**readNamespacedDeploymentStatus**](AppsV1Api.md#readNamespacedDeploymentStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | -[**readNamespacedReplicaSet**](AppsV1Api.md#readNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**readNamespacedReplicaSetScale**](AppsV1Api.md#readNamespacedReplicaSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | -[**readNamespacedReplicaSetStatus**](AppsV1Api.md#readNamespacedReplicaSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | -[**readNamespacedStatefulSet**](AppsV1Api.md#readNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**readNamespacedStatefulSetScale**](AppsV1Api.md#readNamespacedStatefulSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | -[**readNamespacedStatefulSetStatus**](AppsV1Api.md#readNamespacedStatefulSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | -[**replaceNamespacedControllerRevision**](AppsV1Api.md#replaceNamespacedControllerRevision) | **PUT** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**replaceNamespacedDaemonSet**](AppsV1Api.md#replaceNamespacedDaemonSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**replaceNamespacedDaemonSetStatus**](AppsV1Api.md#replaceNamespacedDaemonSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | -[**replaceNamespacedDeployment**](AppsV1Api.md#replaceNamespacedDeployment) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**replaceNamespacedDeploymentScale**](AppsV1Api.md#replaceNamespacedDeploymentScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | -[**replaceNamespacedDeploymentStatus**](AppsV1Api.md#replaceNamespacedDeploymentStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | -[**replaceNamespacedReplicaSet**](AppsV1Api.md#replaceNamespacedReplicaSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**replaceNamespacedReplicaSetScale**](AppsV1Api.md#replaceNamespacedReplicaSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | -[**replaceNamespacedReplicaSetStatus**](AppsV1Api.md#replaceNamespacedReplicaSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | -[**replaceNamespacedStatefulSet**](AppsV1Api.md#replaceNamespacedStatefulSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**replaceNamespacedStatefulSetScale**](AppsV1Api.md#replaceNamespacedStatefulSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | -[**replaceNamespacedStatefulSetStatus**](AppsV1Api.md#replaceNamespacedStatefulSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | - - -# **createNamespacedControllerRevision** -> V1ControllerRevision createNamespacedControllerRevision(body) - -create a ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiCreateNamespacedControllerRevisionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedControllerRevisionRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: {}, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - revision: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ControllerRevision**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ControllerRevision** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedDaemonSet** -> V1DaemonSet createNamespacedDaemonSet(body) - -create a DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiCreateNamespacedDaemonSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedDaemonSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - }, - status: { - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentNumberScheduled: 1, - desiredNumberScheduled: 1, - numberAvailable: 1, - numberMisscheduled: 1, - numberReady: 1, - numberUnavailable: 1, - observedGeneration: 1, - updatedNumberScheduled: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DaemonSet**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1DaemonSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedDeployment** -> V1Deployment createNamespacedDeployment(body) - -create a Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiCreateNamespacedDeploymentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedDeploymentRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - paused: true, - progressDeadlineSeconds: 1, - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - strategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - unavailableReplicas: 1, - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Deployment**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Deployment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedReplicaSet** -> V1ReplicaSet createNamespacedReplicaSet(body) - -create a ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiCreateNamespacedReplicaSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedReplicaSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicaSet**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ReplicaSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedStatefulSet** -> V1StatefulSet createNamespacedStatefulSet(body) - -create a StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiCreateNamespacedStatefulSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedStatefulSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - ordinals: { - start: 1, - }, - persistentVolumeClaimRetentionPolicy: { - whenDeleted: "whenDeleted_example", - whenScaled: "whenScaled_example", - }, - podManagementPolicy: "podManagementPolicy_example", - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - serviceName: "serviceName_example", - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxUnavailable: "maxUnavailable_example", - partition: 1, - }, - type: "type_example", - }, - volumeClaimTemplates: [ - { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - ], - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentReplicas: 1, - currentRevision: "currentRevision_example", - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - updateRevision: "updateRevision_example", - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StatefulSet**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1StatefulSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedControllerRevision** -> V1Status deleteCollectionNamespacedControllerRevision() - -delete collection of ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedDaemonSet** -> V1Status deleteCollectionNamespacedDaemonSet() - -delete collection of DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedDeployment** -> V1Status deleteCollectionNamespacedDeployment() - -delete collection of Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiDeleteCollectionNamespacedDeploymentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedDeploymentRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedReplicaSet** -> V1Status deleteCollectionNamespacedReplicaSet() - -delete collection of ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedStatefulSet** -> V1Status deleteCollectionNamespacedStatefulSet() - -delete collection of StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedControllerRevision** -> V1Status deleteNamespacedControllerRevision() - -delete a ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiDeleteNamespacedControllerRevisionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedDaemonSet** -> V1Status deleteNamespacedDaemonSet() - -delete a DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiDeleteNamespacedDaemonSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedDeployment** -> V1Status deleteNamespacedDeployment() - -delete a Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiDeleteNamespacedDeploymentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedReplicaSet** -> V1Status deleteNamespacedReplicaSet() - -delete a ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiDeleteNamespacedReplicaSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedStatefulSet** -> V1Status deleteNamespacedStatefulSet() - -delete a StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiDeleteNamespacedStatefulSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listControllerRevisionForAllNamespaces** -> V1ControllerRevisionList listControllerRevisionForAllNamespaces() - -list or watch objects of kind ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiListControllerRevisionForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListControllerRevisionForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listControllerRevisionForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ControllerRevisionList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listDaemonSetForAllNamespaces** -> V1DaemonSetList listDaemonSetForAllNamespaces() - -list or watch objects of kind DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiListDaemonSetForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListDaemonSetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDaemonSetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1DaemonSetList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listDeploymentForAllNamespaces** -> V1DeploymentList listDeploymentForAllNamespaces() - -list or watch objects of kind Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiListDeploymentForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListDeploymentForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeploymentForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1DeploymentList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedControllerRevision** -> V1ControllerRevisionList listNamespacedControllerRevision() - -list or watch objects of kind ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiListNamespacedControllerRevisionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedControllerRevisionRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ControllerRevisionList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedDaemonSet** -> V1DaemonSetList listNamespacedDaemonSet() - -list or watch objects of kind DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiListNamespacedDaemonSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedDaemonSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1DaemonSetList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedDeployment** -> V1DeploymentList listNamespacedDeployment() - -list or watch objects of kind Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiListNamespacedDeploymentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedDeploymentRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1DeploymentList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedReplicaSet** -> V1ReplicaSetList listNamespacedReplicaSet() - -list or watch objects of kind ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiListNamespacedReplicaSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedReplicaSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ReplicaSetList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedStatefulSet** -> V1StatefulSetList listNamespacedStatefulSet() - -list or watch objects of kind StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiListNamespacedStatefulSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedStatefulSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1StatefulSetList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listReplicaSetForAllNamespaces** -> V1ReplicaSetList listReplicaSetForAllNamespaces() - -list or watch objects of kind ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiListReplicaSetForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListReplicaSetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listReplicaSetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ReplicaSetList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listStatefulSetForAllNamespaces** -> V1StatefulSetList listStatefulSetForAllNamespaces() - -list or watch objects of kind StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiListStatefulSetForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListStatefulSetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStatefulSetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1StatefulSetList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedControllerRevision** -> V1ControllerRevision patchNamespacedControllerRevision(body) - -partially update the specified ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedControllerRevisionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ControllerRevision** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedDaemonSet** -> V1DaemonSet patchNamespacedDaemonSet(body) - -partially update the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedDaemonSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1DaemonSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedDaemonSetStatus** -> V1DaemonSet patchNamespacedDaemonSetStatus(body) - -partially update status of the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedDaemonSetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDaemonSetStatusRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDaemonSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1DaemonSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedDeployment** -> V1Deployment patchNamespacedDeployment(body) - -partially update the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedDeploymentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Deployment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedDeploymentScale** -> V1Scale patchNamespacedDeploymentScale(body) - -partially update scale of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedDeploymentScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDeploymentScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDeploymentScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedDeploymentStatus** -> V1Deployment patchNamespacedDeploymentStatus(body) - -partially update status of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedDeploymentStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDeploymentStatusRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDeploymentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Deployment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedReplicaSet** -> V1ReplicaSet patchNamespacedReplicaSet(body) - -partially update the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedReplicaSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ReplicaSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedReplicaSetScale** -> V1Scale patchNamespacedReplicaSetScale(body) - -partially update scale of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedReplicaSetScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedReplicaSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicaSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedReplicaSetStatus** -> V1ReplicaSet patchNamespacedReplicaSetStatus(body) - -partially update status of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedReplicaSetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedReplicaSetStatusRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicaSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ReplicaSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedStatefulSet** -> V1StatefulSet patchNamespacedStatefulSet(body) - -partially update the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedStatefulSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1StatefulSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedStatefulSetScale** -> V1Scale patchNamespacedStatefulSetScale(body) - -partially update scale of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedStatefulSetScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedStatefulSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedStatefulSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedStatefulSetStatus** -> V1StatefulSet patchNamespacedStatefulSetStatus(body) - -partially update status of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiPatchNamespacedStatefulSetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedStatefulSetStatusRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedStatefulSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1StatefulSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedControllerRevision** -> V1ControllerRevision readNamespacedControllerRevision() - -read the specified ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedControllerRevisionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ControllerRevision** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedDaemonSet** -> V1DaemonSet readNamespacedDaemonSet() - -read the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedDaemonSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1DaemonSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedDaemonSetStatus** -> V1DaemonSet readNamespacedDaemonSetStatus() - -read status of the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedDaemonSetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDaemonSetStatusRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDaemonSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1DaemonSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedDeployment** -> V1Deployment readNamespacedDeployment() - -read the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedDeploymentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Deployment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedDeploymentScale** -> V1Scale readNamespacedDeploymentScale() - -read scale of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedDeploymentScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDeploymentScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDeploymentScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedDeploymentStatus** -> V1Deployment readNamespacedDeploymentStatus() - -read status of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedDeploymentStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDeploymentStatusRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDeploymentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Deployment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedReplicaSet** -> V1ReplicaSet readNamespacedReplicaSet() - -read the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedReplicaSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ReplicaSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedReplicaSetScale** -> V1Scale readNamespacedReplicaSetScale() - -read scale of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedReplicaSetScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedReplicaSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicaSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedReplicaSetStatus** -> V1ReplicaSet readNamespacedReplicaSetStatus() - -read status of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedReplicaSetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedReplicaSetStatusRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicaSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ReplicaSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedStatefulSet** -> V1StatefulSet readNamespacedStatefulSet() - -read the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedStatefulSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1StatefulSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedStatefulSetScale** -> V1Scale readNamespacedStatefulSetScale() - -read scale of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedStatefulSetScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedStatefulSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedStatefulSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedStatefulSetStatus** -> V1StatefulSet readNamespacedStatefulSetStatus() - -read status of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReadNamespacedStatefulSetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedStatefulSetStatusRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedStatefulSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1StatefulSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedControllerRevision** -> V1ControllerRevision replaceNamespacedControllerRevision(body) - -replace the specified ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedControllerRevisionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: {}, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - revision: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ControllerRevision**| | - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ControllerRevision** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedDaemonSet** -> V1DaemonSet replaceNamespacedDaemonSet(body) - -replace the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedDaemonSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - }, - status: { - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentNumberScheduled: 1, - desiredNumberScheduled: 1, - numberAvailable: 1, - numberMisscheduled: 1, - numberReady: 1, - numberUnavailable: 1, - observedGeneration: 1, - updatedNumberScheduled: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DaemonSet**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1DaemonSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedDaemonSetStatus** -> V1DaemonSet replaceNamespacedDaemonSetStatus(body) - -replace status of the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedDaemonSetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDaemonSetStatusRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - }, - status: { - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentNumberScheduled: 1, - desiredNumberScheduled: 1, - numberAvailable: 1, - numberMisscheduled: 1, - numberReady: 1, - numberUnavailable: 1, - observedGeneration: 1, - updatedNumberScheduled: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDaemonSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DaemonSet**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1DaemonSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedDeployment** -> V1Deployment replaceNamespacedDeployment(body) - -replace the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedDeploymentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - paused: true, - progressDeadlineSeconds: 1, - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - strategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - unavailableReplicas: 1, - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Deployment**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Deployment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedDeploymentScale** -> V1Scale replaceNamespacedDeploymentScale(body) - -replace scale of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedDeploymentScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDeploymentScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDeploymentScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedDeploymentStatus** -> V1Deployment replaceNamespacedDeploymentStatus(body) - -replace status of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedDeploymentStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDeploymentStatusRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - paused: true, - progressDeadlineSeconds: 1, - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - strategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - unavailableReplicas: 1, - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDeploymentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Deployment**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Deployment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedReplicaSet** -> V1ReplicaSet replaceNamespacedReplicaSet(body) - -replace the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedReplicaSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicaSet**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ReplicaSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedReplicaSetScale** -> V1Scale replaceNamespacedReplicaSetScale(body) - -replace scale of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedReplicaSetScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedReplicaSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicaSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedReplicaSetStatus** -> V1ReplicaSet replaceNamespacedReplicaSetStatus(body) - -replace status of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedReplicaSetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedReplicaSetStatusRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicaSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicaSet**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ReplicaSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedStatefulSet** -> V1StatefulSet replaceNamespacedStatefulSet(body) - -replace the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedStatefulSetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - ordinals: { - start: 1, - }, - persistentVolumeClaimRetentionPolicy: { - whenDeleted: "whenDeleted_example", - whenScaled: "whenScaled_example", - }, - podManagementPolicy: "podManagementPolicy_example", - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - serviceName: "serviceName_example", - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxUnavailable: "maxUnavailable_example", - partition: 1, - }, - type: "type_example", - }, - volumeClaimTemplates: [ - { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - ], - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentReplicas: 1, - currentRevision: "currentRevision_example", - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - updateRevision: "updateRevision_example", - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StatefulSet**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1StatefulSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedStatefulSetScale** -> V1Scale replaceNamespacedStatefulSetScale(body) - -replace scale of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedStatefulSetScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedStatefulSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedStatefulSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedStatefulSetStatus** -> V1StatefulSet replaceNamespacedStatefulSetStatus(body) - -replace status of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from ''; -import type { AppsV1ApiReplaceNamespacedStatefulSetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedStatefulSetStatusRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - ordinals: { - start: 1, - }, - persistentVolumeClaimRetentionPolicy: { - whenDeleted: "whenDeleted_example", - whenScaled: "whenScaled_example", - }, - podManagementPolicy: "podManagementPolicy_example", - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - serviceName: "serviceName_example", - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxUnavailable: "maxUnavailable_example", - partition: 1, - }, - type: "type_example", - }, - volumeClaimTemplates: [ - { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - ], - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentReplicas: 1, - currentRevision: "currentRevision_example", - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - updateRevision: "updateRevision_example", - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedStatefulSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StatefulSet**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1StatefulSet** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AuthenticationApi.md b/src/gen/AuthenticationApi.md deleted file mode 100644 index b141ecbe36..0000000000 --- a/src/gen/AuthenticationApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .AuthenticationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](AuthenticationApi.md#getAPIGroup) | **GET** /apis/authentication.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AuthenticationApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AuthenticationV1Api.md b/src/gen/AuthenticationV1Api.md deleted file mode 100644 index 426eecb015..0000000000 --- a/src/gen/AuthenticationV1Api.md +++ /dev/null @@ -1,324 +0,0 @@ -# .AuthenticationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createSelfSubjectReview**](AuthenticationV1Api.md#createSelfSubjectReview) | **POST** /apis/authentication.k8s.io/v1/selfsubjectreviews | -[**createTokenReview**](AuthenticationV1Api.md#createTokenReview) | **POST** /apis/authentication.k8s.io/v1/tokenreviews | -[**getAPIResources**](AuthenticationV1Api.md#getAPIResources) | **GET** /apis/authentication.k8s.io/v1/ | - - -# **createSelfSubjectReview** -> V1SelfSubjectReview createSelfSubjectReview(body) - -create a SelfSubjectReview - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1Api } from ''; -import type { AuthenticationV1ApiCreateSelfSubjectReviewRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1Api(configuration); - -const request: AuthenticationV1ApiCreateSelfSubjectReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - status: { - userInfo: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - uid: "uid_example", - username: "username_example", - }, - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectReview(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SelfSubjectReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1SelfSubjectReview** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createTokenReview** -> V1TokenReview createTokenReview(body) - -create a TokenReview - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1Api } from ''; -import type { AuthenticationV1ApiCreateTokenReviewRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1Api(configuration); - -const request: AuthenticationV1ApiCreateTokenReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - audiences: [ - "audiences_example", - ], - token: "token_example", - }, - status: { - audiences: [ - "audiences_example", - ], - authenticated: true, - error: "error_example", - user: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - uid: "uid_example", - username: "username_example", - }, - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createTokenReview(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1TokenReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1TokenReview** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AuthenticationV1alpha1Api.md b/src/gen/AuthenticationV1alpha1Api.md deleted file mode 100644 index ac1adde800..0000000000 --- a/src/gen/AuthenticationV1alpha1Api.md +++ /dev/null @@ -1,185 +0,0 @@ -# .AuthenticationV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createSelfSubjectReview**](AuthenticationV1alpha1Api.md#createSelfSubjectReview) | **POST** /apis/authentication.k8s.io/v1alpha1/selfsubjectreviews | -[**getAPIResources**](AuthenticationV1alpha1Api.md#getAPIResources) | **GET** /apis/authentication.k8s.io/v1alpha1/ | - - -# **createSelfSubjectReview** -> V1alpha1SelfSubjectReview createSelfSubjectReview(body) - -create a SelfSubjectReview - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1alpha1Api } from ''; -import type { AuthenticationV1alpha1ApiCreateSelfSubjectReviewRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1alpha1Api(configuration); - -const request: AuthenticationV1alpha1ApiCreateSelfSubjectReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - status: { - userInfo: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - uid: "uid_example", - username: "username_example", - }, - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectReview(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1SelfSubjectReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1SelfSubjectReview** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1alpha1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AuthenticationV1beta1Api.md b/src/gen/AuthenticationV1beta1Api.md deleted file mode 100644 index ab4dd33fc8..0000000000 --- a/src/gen/AuthenticationV1beta1Api.md +++ /dev/null @@ -1,185 +0,0 @@ -# .AuthenticationV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createSelfSubjectReview**](AuthenticationV1beta1Api.md#createSelfSubjectReview) | **POST** /apis/authentication.k8s.io/v1beta1/selfsubjectreviews | -[**getAPIResources**](AuthenticationV1beta1Api.md#getAPIResources) | **GET** /apis/authentication.k8s.io/v1beta1/ | - - -# **createSelfSubjectReview** -> V1beta1SelfSubjectReview createSelfSubjectReview(body) - -create a SelfSubjectReview - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1beta1Api } from ''; -import type { AuthenticationV1beta1ApiCreateSelfSubjectReviewRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1beta1Api(configuration); - -const request: AuthenticationV1beta1ApiCreateSelfSubjectReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - status: { - userInfo: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - uid: "uid_example", - username: "username_example", - }, - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectReview(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1SelfSubjectReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1SelfSubjectReview** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1beta1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AuthorizationApi.md b/src/gen/AuthorizationApi.md deleted file mode 100644 index 69c1a79f0f..0000000000 --- a/src/gen/AuthorizationApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .AuthorizationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](AuthorizationApi.md#getAPIGroup) | **GET** /apis/authorization.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AuthorizationApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AuthorizationV1Api.md b/src/gen/AuthorizationV1Api.md deleted file mode 100644 index 3cda3dc62f..0000000000 --- a/src/gen/AuthorizationV1Api.md +++ /dev/null @@ -1,704 +0,0 @@ -# .AuthorizationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLocalSubjectAccessReview**](AuthorizationV1Api.md#createNamespacedLocalSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews | -[**createSelfSubjectAccessReview**](AuthorizationV1Api.md#createSelfSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectaccessreviews | -[**createSelfSubjectRulesReview**](AuthorizationV1Api.md#createSelfSubjectRulesReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectrulesreviews | -[**createSubjectAccessReview**](AuthorizationV1Api.md#createSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/subjectaccessreviews | -[**getAPIResources**](AuthorizationV1Api.md#getAPIResources) | **GET** /apis/authorization.k8s.io/v1/ | - - -# **createNamespacedLocalSubjectAccessReview** -> V1LocalSubjectAccessReview createNamespacedLocalSubjectAccessReview(body) - -create a LocalSubjectAccessReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from ''; -import type { AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - nonResourceAttributes: { - path: "path_example", - verb: "verb_example", - }, - resourceAttributes: { - fieldSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - group: "group_example", - labelSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - subresource: "subresource_example", - verb: "verb_example", - version: "version_example", - }, - uid: "uid_example", - user: "user_example", - }, - status: { - allowed: true, - denied: true, - evaluationError: "evaluationError_example", - reason: "reason_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedLocalSubjectAccessReview(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1LocalSubjectAccessReview**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1LocalSubjectAccessReview** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createSelfSubjectAccessReview** -> V1SelfSubjectAccessReview createSelfSubjectAccessReview(body) - -create a SelfSubjectAccessReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from ''; -import type { AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - nonResourceAttributes: { - path: "path_example", - verb: "verb_example", - }, - resourceAttributes: { - fieldSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - group: "group_example", - labelSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - subresource: "subresource_example", - verb: "verb_example", - version: "version_example", - }, - }, - status: { - allowed: true, - denied: true, - evaluationError: "evaluationError_example", - reason: "reason_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectAccessReview(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SelfSubjectAccessReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1SelfSubjectAccessReview** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createSelfSubjectRulesReview** -> V1SelfSubjectRulesReview createSelfSubjectRulesReview(body) - -create a SelfSubjectRulesReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from ''; -import type { AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - namespace: "namespace_example", - }, - status: { - evaluationError: "evaluationError_example", - incomplete: true, - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectRulesReview(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SelfSubjectRulesReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1SelfSubjectRulesReview** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createSubjectAccessReview** -> V1SubjectAccessReview createSubjectAccessReview(body) - -create a SubjectAccessReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from ''; -import type { AuthorizationV1ApiCreateSubjectAccessReviewRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateSubjectAccessReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - nonResourceAttributes: { - path: "path_example", - verb: "verb_example", - }, - resourceAttributes: { - fieldSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - group: "group_example", - labelSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - subresource: "subresource_example", - verb: "verb_example", - version: "version_example", - }, - uid: "uid_example", - user: "user_example", - }, - status: { - allowed: true, - denied: true, - evaluationError: "evaluationError_example", - reason: "reason_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSubjectAccessReview(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SubjectAccessReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1SubjectAccessReview** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AutoscalingApi.md b/src/gen/AutoscalingApi.md deleted file mode 100644 index c116b93e84..0000000000 --- a/src/gen/AutoscalingApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .AutoscalingApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](AutoscalingApi.md#getAPIGroup) | **GET** /apis/autoscaling/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AutoscalingApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AutoscalingV1Api.md b/src/gen/AutoscalingV1Api.md deleted file mode 100644 index 77c199e966..0000000000 --- a/src/gen/AutoscalingV1Api.md +++ /dev/null @@ -1,1120 +0,0 @@ -# .AutoscalingV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteCollectionNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**getAPIResources**](AutoscalingV1Api.md#getAPIResources) | **GET** /apis/autoscaling/v1/ | -[**listHorizontalPodAutoscalerForAllNamespaces**](AutoscalingV1Api.md#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v1/horizontalpodautoscalers | -[**listNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | -[**patchNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**patchNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV1Api.md#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**readNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**readNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV1Api.md#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**replaceNamespacedHorizontalPodAutoscaler**](AutoscalingV1Api.md#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**replaceNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV1Api.md#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | - - -# **createNamespacedHorizontalPodAutoscaler** -> V1HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) - -create a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxReplicas: 1, - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - targetCPUUtilizationPercentage: 1, - }, - status: { - currentCPUUtilizationPercentage: 1, - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1HorizontalPodAutoscaler**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedHorizontalPodAutoscaler** -> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() - -delete collection of HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedHorizontalPodAutoscaler** -> V1Status deleteNamespacedHorizontalPodAutoscaler() - -delete a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listHorizontalPodAutoscalerForAllNamespaces** -> V1HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1HorizontalPodAutoscalerList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedHorizontalPodAutoscaler** -> V1HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1HorizontalPodAutoscalerList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedHorizontalPodAutoscaler** -> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) - -partially update the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedHorizontalPodAutoscalerStatus** -> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) - -partially update status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedHorizontalPodAutoscaler** -> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() - -read the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedHorizontalPodAutoscalerStatus** -> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() - -read status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedHorizontalPodAutoscaler** -> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) - -replace the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxReplicas: 1, - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - targetCPUUtilizationPercentage: 1, - }, - status: { - currentCPUUtilizationPercentage: 1, - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedHorizontalPodAutoscalerStatus** -> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) - -replace status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from ''; -import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxReplicas: 1, - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - targetCPUUtilizationPercentage: 1, - }, - status: { - currentCPUUtilizationPercentage: 1, - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/AutoscalingV2Api.md b/src/gen/AutoscalingV2Api.md deleted file mode 100644 index c7c2c1e6cf..0000000000 --- a/src/gen/AutoscalingV2Api.md +++ /dev/null @@ -1,1828 +0,0 @@ -# .AutoscalingV2Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteCollectionNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**getAPIResources**](AutoscalingV2Api.md#getAPIResources) | **GET** /apis/autoscaling/v2/ | -[**listHorizontalPodAutoscalerForAllNamespaces**](AutoscalingV2Api.md#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v2/horizontalpodautoscalers | -[**listNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | -[**patchNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**patchNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV2Api.md#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**readNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**readNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV2Api.md#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**replaceNamespacedHorizontalPodAutoscaler**](AutoscalingV2Api.md#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**replaceNamespacedHorizontalPodAutoscalerStatus**](AutoscalingV2Api.md#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | - - -# **createNamespacedHorizontalPodAutoscaler** -> V2HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) - -create a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - behavior: { - scaleDown: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - scaleUp: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - }, - maxReplicas: 1, - metrics: [ - { - containerResource: { - container: "container_example", - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - external: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - object: { - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - pods: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - resource: { - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - type: "type_example", - }, - ], - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentMetrics: [ - { - containerResource: { - container: "container_example", - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - external: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - object: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - pods: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - resource: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - type: "type_example", - }, - ], - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V2HorizontalPodAutoscaler**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V2HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedHorizontalPodAutoscaler** -> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() - -delete collection of HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedHorizontalPodAutoscaler** -> V1Status deleteNamespacedHorizontalPodAutoscaler() - -delete a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listHorizontalPodAutoscalerForAllNamespaces** -> V2HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V2HorizontalPodAutoscalerList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedHorizontalPodAutoscaler** -> V2HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V2HorizontalPodAutoscalerList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedHorizontalPodAutoscaler** -> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) - -partially update the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V2HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedHorizontalPodAutoscalerStatus** -> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) - -partially update status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V2HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedHorizontalPodAutoscaler** -> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() - -read the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V2HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedHorizontalPodAutoscalerStatus** -> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() - -read status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V2HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedHorizontalPodAutoscaler** -> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) - -replace the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - behavior: { - scaleDown: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - scaleUp: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - }, - maxReplicas: 1, - metrics: [ - { - containerResource: { - container: "container_example", - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - external: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - object: { - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - pods: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - resource: { - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - type: "type_example", - }, - ], - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentMetrics: [ - { - containerResource: { - container: "container_example", - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - external: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - object: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - pods: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - resource: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - type: "type_example", - }, - ], - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V2HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V2HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedHorizontalPodAutoscalerStatus** -> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) - -replace status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from ''; -import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - behavior: { - scaleDown: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - scaleUp: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - }, - maxReplicas: 1, - metrics: [ - { - containerResource: { - container: "container_example", - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - external: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - object: { - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - pods: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - resource: { - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - type: "type_example", - }, - ], - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentMetrics: [ - { - containerResource: { - container: "container_example", - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - external: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - object: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - pods: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - resource: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - type: "type_example", - }, - ], - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V2HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V2HorizontalPodAutoscaler** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/BatchApi.md b/src/gen/BatchApi.md deleted file mode 100644 index 12d7a4b468..0000000000 --- a/src/gen/BatchApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .BatchApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](BatchApi.md#getAPIGroup) | **GET** /apis/batch/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, BatchApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/BatchV1Api.md b/src/gen/BatchV1Api.md deleted file mode 100644 index 901c763f22..0000000000 --- a/src/gen/BatchV1Api.md +++ /dev/null @@ -1,13484 +0,0 @@ -# .BatchV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedCronJob**](BatchV1Api.md#createNamespacedCronJob) | **POST** /apis/batch/v1/namespaces/{namespace}/cronjobs | -[**createNamespacedJob**](BatchV1Api.md#createNamespacedJob) | **POST** /apis/batch/v1/namespaces/{namespace}/jobs | -[**deleteCollectionNamespacedCronJob**](BatchV1Api.md#deleteCollectionNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs | -[**deleteCollectionNamespacedJob**](BatchV1Api.md#deleteCollectionNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs | -[**deleteNamespacedCronJob**](BatchV1Api.md#deleteNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**deleteNamespacedJob**](BatchV1Api.md#deleteNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**getAPIResources**](BatchV1Api.md#getAPIResources) | **GET** /apis/batch/v1/ | -[**listCronJobForAllNamespaces**](BatchV1Api.md#listCronJobForAllNamespaces) | **GET** /apis/batch/v1/cronjobs | -[**listJobForAllNamespaces**](BatchV1Api.md#listJobForAllNamespaces) | **GET** /apis/batch/v1/jobs | -[**listNamespacedCronJob**](BatchV1Api.md#listNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs | -[**listNamespacedJob**](BatchV1Api.md#listNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs | -[**patchNamespacedCronJob**](BatchV1Api.md#patchNamespacedCronJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**patchNamespacedCronJobStatus**](BatchV1Api.md#patchNamespacedCronJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | -[**patchNamespacedJob**](BatchV1Api.md#patchNamespacedJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**patchNamespacedJobStatus**](BatchV1Api.md#patchNamespacedJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | -[**readNamespacedCronJob**](BatchV1Api.md#readNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**readNamespacedCronJobStatus**](BatchV1Api.md#readNamespacedCronJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | -[**readNamespacedJob**](BatchV1Api.md#readNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**readNamespacedJobStatus**](BatchV1Api.md#readNamespacedJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | -[**replaceNamespacedCronJob**](BatchV1Api.md#replaceNamespacedCronJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**replaceNamespacedCronJobStatus**](BatchV1Api.md#replaceNamespacedCronJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | -[**replaceNamespacedJob**](BatchV1Api.md#replaceNamespacedJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**replaceNamespacedJobStatus**](BatchV1Api.md#replaceNamespacedJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | - - -# **createNamespacedCronJob** -> V1CronJob createNamespacedCronJob(body) - -create a CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiCreateNamespacedCronJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiCreateNamespacedCronJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - concurrencyPolicy: "concurrencyPolicy_example", - failedJobsHistoryLimit: 1, - jobTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - }, - schedule: "schedule_example", - startingDeadlineSeconds: 1, - successfulJobsHistoryLimit: 1, - suspend: true, - timeZone: "timeZone_example", - }, - status: { - active: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), - lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CronJob**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CronJob** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedJob** -> V1Job createNamespacedJob(body) - -create a Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiCreateNamespacedJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiCreateNamespacedJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - status: { - active: 1, - completedIndexes: "completedIndexes_example", - completionTime: new Date('1970-01-01T00:00:00.00Z'), - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - failed: 1, - failedIndexes: "failedIndexes_example", - ready: 1, - startTime: new Date('1970-01-01T00:00:00.00Z'), - succeeded: 1, - terminating: 1, - uncountedTerminatedPods: { - failed: [ - "failed_example", - ], - succeeded: [ - "succeeded_example", - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Job**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Job** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedCronJob** -> V1Status deleteCollectionNamespacedCronJob() - -delete collection of CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiDeleteCollectionNamespacedCronJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteCollectionNamespacedCronJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedJob** -> V1Status deleteCollectionNamespacedJob() - -delete collection of Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiDeleteCollectionNamespacedJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteCollectionNamespacedJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedCronJob** -> V1Status deleteNamespacedCronJob() - -delete a CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiDeleteNamespacedCronJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedJob** -> V1Status deleteNamespacedJob() - -delete a Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiDeleteNamespacedJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listCronJobForAllNamespaces** -> V1CronJobList listCronJobForAllNamespaces() - -list or watch objects of kind CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiListCronJobForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListCronJobForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCronJobForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1CronJobList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listJobForAllNamespaces** -> V1JobList listJobForAllNamespaces() - -list or watch objects of kind Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiListJobForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListJobForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listJobForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1JobList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedCronJob** -> V1CronJobList listNamespacedCronJob() - -list or watch objects of kind CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiListNamespacedCronJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListNamespacedCronJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1CronJobList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedJob** -> V1JobList listNamespacedJob() - -list or watch objects of kind Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiListNamespacedJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListNamespacedJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1JobList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedCronJob** -> V1CronJob patchNamespacedCronJob(body) - -partially update the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiPatchNamespacedCronJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1CronJob** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedCronJobStatus** -> V1CronJob patchNamespacedCronJobStatus(body) - -partially update status of the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiPatchNamespacedCronJobStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedCronJobStatusRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCronJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1CronJob** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedJob** -> V1Job patchNamespacedJob(body) - -partially update the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiPatchNamespacedJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Job** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedJobStatus** -> V1Job patchNamespacedJobStatus(body) - -partially update status of the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiPatchNamespacedJobStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedJobStatusRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Job** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedCronJob** -> V1CronJob readNamespacedCronJob() - -read the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiReadNamespacedCronJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1CronJob** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedCronJobStatus** -> V1CronJob readNamespacedCronJobStatus() - -read status of the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiReadNamespacedCronJobStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedCronJobStatusRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedCronJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1CronJob** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedJob** -> V1Job readNamespacedJob() - -read the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiReadNamespacedJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Job** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedJobStatus** -> V1Job readNamespacedJobStatus() - -read status of the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiReadNamespacedJobStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedJobStatusRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Job** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedCronJob** -> V1CronJob replaceNamespacedCronJob(body) - -replace the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiReplaceNamespacedCronJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - concurrencyPolicy: "concurrencyPolicy_example", - failedJobsHistoryLimit: 1, - jobTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - }, - schedule: "schedule_example", - startingDeadlineSeconds: 1, - successfulJobsHistoryLimit: 1, - suspend: true, - timeZone: "timeZone_example", - }, - status: { - active: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), - lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CronJob**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CronJob** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedCronJobStatus** -> V1CronJob replaceNamespacedCronJobStatus(body) - -replace status of the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiReplaceNamespacedCronJobStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedCronJobStatusRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - concurrencyPolicy: "concurrencyPolicy_example", - failedJobsHistoryLimit: 1, - jobTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - }, - schedule: "schedule_example", - startingDeadlineSeconds: 1, - successfulJobsHistoryLimit: 1, - suspend: true, - timeZone: "timeZone_example", - }, - status: { - active: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), - lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCronJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CronJob**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CronJob** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedJob** -> V1Job replaceNamespacedJob(body) - -replace the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiReplaceNamespacedJobRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - status: { - active: 1, - completedIndexes: "completedIndexes_example", - completionTime: new Date('1970-01-01T00:00:00.00Z'), - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - failed: 1, - failedIndexes: "failedIndexes_example", - ready: 1, - startTime: new Date('1970-01-01T00:00:00.00Z'), - succeeded: 1, - terminating: 1, - uncountedTerminatedPods: { - failed: [ - "failed_example", - ], - succeeded: [ - "succeeded_example", - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Job**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Job** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedJobStatus** -> V1Job replaceNamespacedJobStatus(body) - -replace status of the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from ''; -import type { BatchV1ApiReplaceNamespacedJobStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedJobStatusRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - status: { - active: 1, - completedIndexes: "completedIndexes_example", - completionTime: new Date('1970-01-01T00:00:00.00Z'), - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - failed: 1, - failedIndexes: "failedIndexes_example", - ready: 1, - startTime: new Date('1970-01-01T00:00:00.00Z'), - succeeded: 1, - terminating: 1, - uncountedTerminatedPods: { - failed: [ - "failed_example", - ], - succeeded: [ - "succeeded_example", - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Job**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Job** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CertificatesApi.md b/src/gen/CertificatesApi.md deleted file mode 100644 index 72f718b2c4..0000000000 --- a/src/gen/CertificatesApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .CertificatesApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](CertificatesApi.md#getAPIGroup) | **GET** /apis/certificates.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, CertificatesApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CertificatesV1Api.md b/src/gen/CertificatesV1Api.md deleted file mode 100644 index 04d6d18f12..0000000000 --- a/src/gen/CertificatesV1Api.md +++ /dev/null @@ -1,1326 +0,0 @@ -# .CertificatesV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createCertificateSigningRequest**](CertificatesV1Api.md#createCertificateSigningRequest) | **POST** /apis/certificates.k8s.io/v1/certificatesigningrequests | -[**deleteCertificateSigningRequest**](CertificatesV1Api.md#deleteCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**deleteCollectionCertificateSigningRequest**](CertificatesV1Api.md#deleteCollectionCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests | -[**getAPIResources**](CertificatesV1Api.md#getAPIResources) | **GET** /apis/certificates.k8s.io/v1/ | -[**listCertificateSigningRequest**](CertificatesV1Api.md#listCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests | -[**patchCertificateSigningRequest**](CertificatesV1Api.md#patchCertificateSigningRequest) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**patchCertificateSigningRequestApproval**](CertificatesV1Api.md#patchCertificateSigningRequestApproval) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | -[**patchCertificateSigningRequestStatus**](CertificatesV1Api.md#patchCertificateSigningRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | -[**readCertificateSigningRequest**](CertificatesV1Api.md#readCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**readCertificateSigningRequestApproval**](CertificatesV1Api.md#readCertificateSigningRequestApproval) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | -[**readCertificateSigningRequestStatus**](CertificatesV1Api.md#readCertificateSigningRequestStatus) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | -[**replaceCertificateSigningRequest**](CertificatesV1Api.md#replaceCertificateSigningRequest) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**replaceCertificateSigningRequestApproval**](CertificatesV1Api.md#replaceCertificateSigningRequestApproval) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | -[**replaceCertificateSigningRequestStatus**](CertificatesV1Api.md#replaceCertificateSigningRequestStatus) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | - - -# **createCertificateSigningRequest** -> V1CertificateSigningRequest createCertificateSigningRequest(body) - -create a CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiCreateCertificateSigningRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiCreateCertificateSigningRequestRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCertificateSigningRequest** -> V1Status deleteCertificateSigningRequest() - -delete a CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiDeleteCertificateSigningRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiDeleteCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionCertificateSigningRequest** -> V1Status deleteCollectionCertificateSigningRequest() - -delete collection of CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listCertificateSigningRequest** -> V1CertificateSigningRequestList listCertificateSigningRequest() - -list or watch objects of kind CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiListCertificateSigningRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiListCertificateSigningRequestRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequestList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchCertificateSigningRequest** -> V1CertificateSigningRequest patchCertificateSigningRequest(body) - -partially update the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiPatchCertificateSigningRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiPatchCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchCertificateSigningRequestApproval** -> V1CertificateSigningRequest patchCertificateSigningRequestApproval(body) - -partially update approval of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCertificateSigningRequestApproval(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchCertificateSigningRequestStatus** -> V1CertificateSigningRequest patchCertificateSigningRequestStatus(body) - -partially update status of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiPatchCertificateSigningRequestStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiPatchCertificateSigningRequestStatusRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCertificateSigningRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readCertificateSigningRequest** -> V1CertificateSigningRequest readCertificateSigningRequest() - -read the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiReadCertificateSigningRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReadCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readCertificateSigningRequestApproval** -> V1CertificateSigningRequest readCertificateSigningRequestApproval() - -read approval of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiReadCertificateSigningRequestApprovalRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReadCertificateSigningRequestApprovalRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCertificateSigningRequestApproval(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readCertificateSigningRequestStatus** -> V1CertificateSigningRequest readCertificateSigningRequestStatus() - -read status of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiReadCertificateSigningRequestStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReadCertificateSigningRequestStatusRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCertificateSigningRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceCertificateSigningRequest** -> V1CertificateSigningRequest replaceCertificateSigningRequest(body) - -replace the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiReplaceCertificateSigningRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReplaceCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceCertificateSigningRequestApproval** -> V1CertificateSigningRequest replaceCertificateSigningRequestApproval(body) - -replace approval of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCertificateSigningRequestApproval(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceCertificateSigningRequestStatus** -> V1CertificateSigningRequest replaceCertificateSigningRequestStatus(body) - -replace status of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from ''; -import type { CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCertificateSigningRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CertificateSigningRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CertificatesV1alpha1Api.md b/src/gen/CertificatesV1alpha1Api.md deleted file mode 100644 index 359cf306c8..0000000000 --- a/src/gen/CertificatesV1alpha1Api.md +++ /dev/null @@ -1,714 +0,0 @@ -# .CertificatesV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterTrustBundle**](CertificatesV1alpha1Api.md#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | -[**deleteClusterTrustBundle**](CertificatesV1alpha1Api.md#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | -[**deleteCollectionClusterTrustBundle**](CertificatesV1alpha1Api.md#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | -[**getAPIResources**](CertificatesV1alpha1Api.md#getAPIResources) | **GET** /apis/certificates.k8s.io/v1alpha1/ | -[**listClusterTrustBundle**](CertificatesV1alpha1Api.md#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | -[**patchClusterTrustBundle**](CertificatesV1alpha1Api.md#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | -[**readClusterTrustBundle**](CertificatesV1alpha1Api.md#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | -[**replaceClusterTrustBundle**](CertificatesV1alpha1Api.md#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | - - -# **createClusterTrustBundle** -> V1alpha1ClusterTrustBundle createClusterTrustBundle(body) - -create a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from ''; -import type { CertificatesV1alpha1ApiCreateClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiCreateClusterTrustBundleRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1ClusterTrustBundle**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1ClusterTrustBundle** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteClusterTrustBundle** -> V1Status deleteClusterTrustBundle() - -delete a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from ''; -import type { CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionClusterTrustBundle** -> V1Status deleteCollectionClusterTrustBundle() - -delete collection of ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from ''; -import type { CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listClusterTrustBundle** -> V1alpha1ClusterTrustBundleList listClusterTrustBundle() - -list or watch objects of kind ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from ''; -import type { CertificatesV1alpha1ApiListClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiListClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha1ClusterTrustBundleList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchClusterTrustBundle** -> V1alpha1ClusterTrustBundle patchClusterTrustBundle(body) - -partially update the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from ''; -import type { CertificatesV1alpha1ApiPatchClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiPatchClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1ClusterTrustBundle** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readClusterTrustBundle** -> V1alpha1ClusterTrustBundle readClusterTrustBundle() - -read the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from ''; -import type { CertificatesV1alpha1ApiReadClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiReadClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1ClusterTrustBundle** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceClusterTrustBundle** -> V1alpha1ClusterTrustBundle replaceClusterTrustBundle(body) - -replace the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from ''; -import type { CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1ClusterTrustBundle**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1ClusterTrustBundle** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CertificatesV1beta1Api.md b/src/gen/CertificatesV1beta1Api.md deleted file mode 100644 index c3441c934c..0000000000 --- a/src/gen/CertificatesV1beta1Api.md +++ /dev/null @@ -1,1819 +0,0 @@ -# .CertificatesV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterTrustBundle**](CertificatesV1beta1Api.md#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | -[**createNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#createNamespacedPodCertificateRequest) | **POST** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | -[**deleteClusterTrustBundle**](CertificatesV1beta1Api.md#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**deleteCollectionClusterTrustBundle**](CertificatesV1beta1Api.md#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | -[**deleteCollectionNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#deleteCollectionNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | -[**deleteNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#deleteNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**getAPIResources**](CertificatesV1beta1Api.md#getAPIResources) | **GET** /apis/certificates.k8s.io/v1beta1/ | -[**listClusterTrustBundle**](CertificatesV1beta1Api.md#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | -[**listNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#listNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | -[**listPodCertificateRequestForAllNamespaces**](CertificatesV1beta1Api.md#listPodCertificateRequestForAllNamespaces) | **GET** /apis/certificates.k8s.io/v1beta1/podcertificaterequests | -[**patchClusterTrustBundle**](CertificatesV1beta1Api.md#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**patchNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#patchNamespacedPodCertificateRequest) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**patchNamespacedPodCertificateRequestStatus**](CertificatesV1beta1Api.md#patchNamespacedPodCertificateRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | -[**readClusterTrustBundle**](CertificatesV1beta1Api.md#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**readNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#readNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**readNamespacedPodCertificateRequestStatus**](CertificatesV1beta1Api.md#readNamespacedPodCertificateRequestStatus) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | -[**replaceClusterTrustBundle**](CertificatesV1beta1Api.md#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**replaceNamespacedPodCertificateRequest**](CertificatesV1beta1Api.md#replaceNamespacedPodCertificateRequest) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**replaceNamespacedPodCertificateRequestStatus**](CertificatesV1beta1Api.md#replaceNamespacedPodCertificateRequestStatus) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | - - -# **createClusterTrustBundle** -> V1beta1ClusterTrustBundle createClusterTrustBundle(body) - -create a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiCreateClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiCreateClusterTrustBundleRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ClusterTrustBundle**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ClusterTrustBundle** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedPodCertificateRequest** -> V1beta1PodCertificateRequest createNamespacedPodCertificateRequest(body) - -create a PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxExpirationSeconds: 1, - nodeName: "nodeName_example", - nodeUID: "nodeUID_example", - pkixPublicKey: 'YQ==', - podName: "podName_example", - podUID: "podUID_example", - proofOfPossession: 'YQ==', - serviceAccountName: "serviceAccountName_example", - serviceAccountUID: "serviceAccountUID_example", - signerName: "signerName_example", - unverifiedUserAnnotations: { - "key": "key_example", - }, - }, - status: { - beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), - certificateChain: "certificateChain_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - notAfter: new Date('1970-01-01T00:00:00.00Z'), - notBefore: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1PodCertificateRequest**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1PodCertificateRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteClusterTrustBundle** -> V1Status deleteClusterTrustBundle() - -delete a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiDeleteClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionClusterTrustBundle** -> V1Status deleteCollectionClusterTrustBundle() - -delete collection of ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedPodCertificateRequest** -> V1Status deleteCollectionNamespacedPodCertificateRequest() - -delete collection of PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedPodCertificateRequest** -> V1Status deleteNamespacedPodCertificateRequest() - -delete a PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listClusterTrustBundle** -> V1beta1ClusterTrustBundleList listClusterTrustBundle() - -list or watch objects of kind ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiListClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiListClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1ClusterTrustBundleList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedPodCertificateRequest** -> V1beta1PodCertificateRequestList listNamespacedPodCertificateRequest() - -list or watch objects of kind PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1PodCertificateRequestList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listPodCertificateRequestForAllNamespaces** -> V1beta1PodCertificateRequestList listPodCertificateRequestForAllNamespaces() - -list or watch objects of kind PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodCertificateRequestForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1PodCertificateRequestList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchClusterTrustBundle** -> V1beta1ClusterTrustBundle patchClusterTrustBundle(body) - -partially update the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiPatchClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiPatchClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1ClusterTrustBundle** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPodCertificateRequest** -> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequest(body) - -partially update the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1PodCertificateRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPodCertificateRequestStatus** -> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequestStatus(body) - -partially update status of the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodCertificateRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1PodCertificateRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readClusterTrustBundle** -> V1beta1ClusterTrustBundle readClusterTrustBundle() - -read the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiReadClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReadClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1ClusterTrustBundle** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodCertificateRequest** -> V1beta1PodCertificateRequest readNamespacedPodCertificateRequest() - -read the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1PodCertificateRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodCertificateRequestStatus** -> V1beta1PodCertificateRequest readNamespacedPodCertificateRequestStatus() - -read status of the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodCertificateRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1PodCertificateRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceClusterTrustBundle** -> V1beta1ClusterTrustBundle replaceClusterTrustBundle(body) - -replace the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiReplaceClusterTrustBundleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReplaceClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ClusterTrustBundle**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ClusterTrustBundle** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPodCertificateRequest** -> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequest(body) - -replace the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxExpirationSeconds: 1, - nodeName: "nodeName_example", - nodeUID: "nodeUID_example", - pkixPublicKey: 'YQ==', - podName: "podName_example", - podUID: "podUID_example", - proofOfPossession: 'YQ==', - serviceAccountName: "serviceAccountName_example", - serviceAccountUID: "serviceAccountUID_example", - signerName: "signerName_example", - unverifiedUserAnnotations: { - "key": "key_example", - }, - }, - status: { - beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), - certificateChain: "certificateChain_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - notAfter: new Date('1970-01-01T00:00:00.00Z'), - notBefore: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1PodCertificateRequest**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1PodCertificateRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPodCertificateRequestStatus** -> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequestStatus(body) - -replace status of the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from ''; -import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxExpirationSeconds: 1, - nodeName: "nodeName_example", - nodeUID: "nodeUID_example", - pkixPublicKey: 'YQ==', - podName: "podName_example", - podUID: "podUID_example", - proofOfPossession: 'YQ==', - serviceAccountName: "serviceAccountName_example", - serviceAccountUID: "serviceAccountUID_example", - signerName: "signerName_example", - unverifiedUserAnnotations: { - "key": "key_example", - }, - }, - status: { - beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), - certificateChain: "certificateChain_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - notAfter: new Date('1970-01-01T00:00:00.00Z'), - notBefore: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodCertificateRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1PodCertificateRequest**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1PodCertificateRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CoordinationApi.md b/src/gen/CoordinationApi.md deleted file mode 100644 index f56bfbd1b6..0000000000 --- a/src/gen/CoordinationApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .CoordinationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](CoordinationApi.md#getAPIGroup) | **GET** /apis/coordination.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, CoordinationApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CoordinationV1Api.md b/src/gen/CoordinationV1Api.md deleted file mode 100644 index 97de52c819..0000000000 --- a/src/gen/CoordinationV1Api.md +++ /dev/null @@ -1,830 +0,0 @@ -# .CoordinationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLease**](CoordinationV1Api.md#createNamespacedLease) | **POST** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | -[**deleteCollectionNamespacedLease**](CoordinationV1Api.md#deleteCollectionNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | -[**deleteNamespacedLease**](CoordinationV1Api.md#deleteNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | -[**getAPIResources**](CoordinationV1Api.md#getAPIResources) | **GET** /apis/coordination.k8s.io/v1/ | -[**listLeaseForAllNamespaces**](CoordinationV1Api.md#listLeaseForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1/leases | -[**listNamespacedLease**](CoordinationV1Api.md#listNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | -[**patchNamespacedLease**](CoordinationV1Api.md#patchNamespacedLease) | **PATCH** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | -[**readNamespacedLease**](CoordinationV1Api.md#readNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | -[**replaceNamespacedLease**](CoordinationV1Api.md#replaceNamespacedLease) | **PUT** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | - - -# **createNamespacedLease** -> V1Lease createNamespacedLease(body) - -create a Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from ''; -import type { CoordinationV1ApiCreateNamespacedLeaseRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiCreateNamespacedLeaseRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - acquireTime: "acquireTime_example", - holderIdentity: "holderIdentity_example", - leaseDurationSeconds: 1, - leaseTransitions: 1, - preferredHolder: "preferredHolder_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Lease**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Lease** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedLease** -> V1Status deleteCollectionNamespacedLease() - -delete collection of Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from ''; -import type { CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedLease** -> V1Status deleteNamespacedLease() - -delete a Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from ''; -import type { CoordinationV1ApiDeleteNamespacedLeaseRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiDeleteNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listLeaseForAllNamespaces** -> V1LeaseList listLeaseForAllNamespaces() - -list or watch objects of kind Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from ''; -import type { CoordinationV1ApiListLeaseForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiListLeaseForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLeaseForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1LeaseList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedLease** -> V1LeaseList listNamespacedLease() - -list or watch objects of kind Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from ''; -import type { CoordinationV1ApiListNamespacedLeaseRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiListNamespacedLeaseRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1LeaseList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedLease** -> V1Lease patchNamespacedLease(body) - -partially update the specified Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from ''; -import type { CoordinationV1ApiPatchNamespacedLeaseRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiPatchNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Lease** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedLease** -> V1Lease readNamespacedLease() - -read the specified Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from ''; -import type { CoordinationV1ApiReadNamespacedLeaseRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiReadNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Lease** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedLease** -> V1Lease replaceNamespacedLease(body) - -replace the specified Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from ''; -import type { CoordinationV1ApiReplaceNamespacedLeaseRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiReplaceNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - acquireTime: "acquireTime_example", - holderIdentity: "holderIdentity_example", - leaseDurationSeconds: 1, - leaseTransitions: 1, - preferredHolder: "preferredHolder_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Lease**| | - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Lease** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CoordinationV1alpha2Api.md b/src/gen/CoordinationV1alpha2Api.md deleted file mode 100644 index 76d509e1bd..0000000000 --- a/src/gen/CoordinationV1alpha2Api.md +++ /dev/null @@ -1,828 +0,0 @@ -# .CoordinationV1alpha2Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | -[**deleteCollectionNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | -[**deleteNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | -[**getAPIResources**](CoordinationV1alpha2Api.md#getAPIResources) | **GET** /apis/coordination.k8s.io/v1alpha2/ | -[**listLeaseCandidateForAllNamespaces**](CoordinationV1alpha2Api.md#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1alpha2/leasecandidates | -[**listNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | -[**patchNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | -[**readNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | -[**replaceNamespacedLeaseCandidate**](CoordinationV1alpha2Api.md#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | - - -# **createNamespacedLeaseCandidate** -> V1alpha2LeaseCandidate createNamespacedLeaseCandidate(body) - -create a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from ''; -import type { CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2LeaseCandidate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2LeaseCandidate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedLeaseCandidate** -> V1Status deleteCollectionNamespacedLeaseCandidate() - -delete collection of LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from ''; -import type { CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedLeaseCandidate** -> V1Status deleteNamespacedLeaseCandidate() - -delete a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from ''; -import type { CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listLeaseCandidateForAllNamespaces** -> V1alpha2LeaseCandidateList listLeaseCandidateForAllNamespaces() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from ''; -import type { CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2LeaseCandidateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedLeaseCandidate** -> V1alpha2LeaseCandidateList listNamespacedLeaseCandidate() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from ''; -import type { CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2LeaseCandidateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedLeaseCandidate** -> V1alpha2LeaseCandidate patchNamespacedLeaseCandidate(body) - -partially update the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from ''; -import type { CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha2LeaseCandidate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedLeaseCandidate** -> V1alpha2LeaseCandidate readNamespacedLeaseCandidate() - -read the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from ''; -import type { CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha2LeaseCandidate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedLeaseCandidate** -> V1alpha2LeaseCandidate replaceNamespacedLeaseCandidate(body) - -replace the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from ''; -import type { CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2LeaseCandidate**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2LeaseCandidate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CoordinationV1beta1Api.md b/src/gen/CoordinationV1beta1Api.md deleted file mode 100644 index 4451a068b5..0000000000 --- a/src/gen/CoordinationV1beta1Api.md +++ /dev/null @@ -1,828 +0,0 @@ -# .CoordinationV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | -[**deleteCollectionNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | -[**deleteNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | -[**getAPIResources**](CoordinationV1beta1Api.md#getAPIResources) | **GET** /apis/coordination.k8s.io/v1beta1/ | -[**listLeaseCandidateForAllNamespaces**](CoordinationV1beta1Api.md#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1beta1/leasecandidates | -[**listNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | -[**patchNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | -[**readNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | -[**replaceNamespacedLeaseCandidate**](CoordinationV1beta1Api.md#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | - - -# **createNamespacedLeaseCandidate** -> V1beta1LeaseCandidate createNamespacedLeaseCandidate(body) - -create a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from ''; -import type { CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1LeaseCandidate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1LeaseCandidate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedLeaseCandidate** -> V1Status deleteCollectionNamespacedLeaseCandidate() - -delete collection of LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from ''; -import type { CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedLeaseCandidate** -> V1Status deleteNamespacedLeaseCandidate() - -delete a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from ''; -import type { CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listLeaseCandidateForAllNamespaces** -> V1beta1LeaseCandidateList listLeaseCandidateForAllNamespaces() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from ''; -import type { CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1LeaseCandidateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedLeaseCandidate** -> V1beta1LeaseCandidateList listNamespacedLeaseCandidate() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from ''; -import type { CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1LeaseCandidateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedLeaseCandidate** -> V1beta1LeaseCandidate patchNamespacedLeaseCandidate(body) - -partially update the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from ''; -import type { CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1LeaseCandidate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedLeaseCandidate** -> V1beta1LeaseCandidate readNamespacedLeaseCandidate() - -read the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from ''; -import type { CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1LeaseCandidate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedLeaseCandidate** -> V1beta1LeaseCandidate replaceNamespacedLeaseCandidate(body) - -replace the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from ''; -import type { CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1LeaseCandidate**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1LeaseCandidate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CoreApi.md b/src/gen/CoreApi.md deleted file mode 100644 index 3156b4ac61..0000000000 --- a/src/gen/CoreApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .CoreApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIVersions**](CoreApi.md#getAPIVersions) | **GET** /api/ | - - -# **getAPIVersions** -> V1APIVersions getAPIVersions() - -get available API versions - -### Example - - -```typescript -import { createConfiguration, CoreApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIVersions(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIVersions** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CoreV1Api.md b/src/gen/CoreV1Api.md deleted file mode 100644 index 5410fe8200..0000000000 --- a/src/gen/CoreV1Api.md +++ /dev/null @@ -1,39216 +0,0 @@ -# .CoreV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**connectDeleteNamespacedPodProxy**](CoreV1Api.md#connectDeleteNamespacedPodProxy) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectDeleteNamespacedPodProxyWithPath**](CoreV1Api.md#connectDeleteNamespacedPodProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectDeleteNamespacedServiceProxy**](CoreV1Api.md#connectDeleteNamespacedServiceProxy) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectDeleteNamespacedServiceProxyWithPath**](CoreV1Api.md#connectDeleteNamespacedServiceProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectDeleteNodeProxy**](CoreV1Api.md#connectDeleteNodeProxy) | **DELETE** /api/v1/nodes/{name}/proxy | -[**connectDeleteNodeProxyWithPath**](CoreV1Api.md#connectDeleteNodeProxyWithPath) | **DELETE** /api/v1/nodes/{name}/proxy/{path} | -[**connectGetNamespacedPodAttach**](CoreV1Api.md#connectGetNamespacedPodAttach) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/attach | -[**connectGetNamespacedPodExec**](CoreV1Api.md#connectGetNamespacedPodExec) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/exec | -[**connectGetNamespacedPodPortforward**](CoreV1Api.md#connectGetNamespacedPodPortforward) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/portforward | -[**connectGetNamespacedPodProxy**](CoreV1Api.md#connectGetNamespacedPodProxy) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectGetNamespacedPodProxyWithPath**](CoreV1Api.md#connectGetNamespacedPodProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectGetNamespacedServiceProxy**](CoreV1Api.md#connectGetNamespacedServiceProxy) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectGetNamespacedServiceProxyWithPath**](CoreV1Api.md#connectGetNamespacedServiceProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectGetNodeProxy**](CoreV1Api.md#connectGetNodeProxy) | **GET** /api/v1/nodes/{name}/proxy | -[**connectGetNodeProxyWithPath**](CoreV1Api.md#connectGetNodeProxyWithPath) | **GET** /api/v1/nodes/{name}/proxy/{path} | -[**connectHeadNamespacedPodProxy**](CoreV1Api.md#connectHeadNamespacedPodProxy) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectHeadNamespacedPodProxyWithPath**](CoreV1Api.md#connectHeadNamespacedPodProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectHeadNamespacedServiceProxy**](CoreV1Api.md#connectHeadNamespacedServiceProxy) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectHeadNamespacedServiceProxyWithPath**](CoreV1Api.md#connectHeadNamespacedServiceProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectHeadNodeProxy**](CoreV1Api.md#connectHeadNodeProxy) | **HEAD** /api/v1/nodes/{name}/proxy | -[**connectHeadNodeProxyWithPath**](CoreV1Api.md#connectHeadNodeProxyWithPath) | **HEAD** /api/v1/nodes/{name}/proxy/{path} | -[**connectOptionsNamespacedPodProxy**](CoreV1Api.md#connectOptionsNamespacedPodProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectOptionsNamespacedPodProxyWithPath**](CoreV1Api.md#connectOptionsNamespacedPodProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectOptionsNamespacedServiceProxy**](CoreV1Api.md#connectOptionsNamespacedServiceProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectOptionsNamespacedServiceProxyWithPath**](CoreV1Api.md#connectOptionsNamespacedServiceProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectOptionsNodeProxy**](CoreV1Api.md#connectOptionsNodeProxy) | **OPTIONS** /api/v1/nodes/{name}/proxy | -[**connectOptionsNodeProxyWithPath**](CoreV1Api.md#connectOptionsNodeProxyWithPath) | **OPTIONS** /api/v1/nodes/{name}/proxy/{path} | -[**connectPatchNamespacedPodProxy**](CoreV1Api.md#connectPatchNamespacedPodProxy) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectPatchNamespacedPodProxyWithPath**](CoreV1Api.md#connectPatchNamespacedPodProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectPatchNamespacedServiceProxy**](CoreV1Api.md#connectPatchNamespacedServiceProxy) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectPatchNamespacedServiceProxyWithPath**](CoreV1Api.md#connectPatchNamespacedServiceProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectPatchNodeProxy**](CoreV1Api.md#connectPatchNodeProxy) | **PATCH** /api/v1/nodes/{name}/proxy | -[**connectPatchNodeProxyWithPath**](CoreV1Api.md#connectPatchNodeProxyWithPath) | **PATCH** /api/v1/nodes/{name}/proxy/{path} | -[**connectPostNamespacedPodAttach**](CoreV1Api.md#connectPostNamespacedPodAttach) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/attach | -[**connectPostNamespacedPodExec**](CoreV1Api.md#connectPostNamespacedPodExec) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/exec | -[**connectPostNamespacedPodPortforward**](CoreV1Api.md#connectPostNamespacedPodPortforward) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/portforward | -[**connectPostNamespacedPodProxy**](CoreV1Api.md#connectPostNamespacedPodProxy) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectPostNamespacedPodProxyWithPath**](CoreV1Api.md#connectPostNamespacedPodProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectPostNamespacedServiceProxy**](CoreV1Api.md#connectPostNamespacedServiceProxy) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectPostNamespacedServiceProxyWithPath**](CoreV1Api.md#connectPostNamespacedServiceProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectPostNodeProxy**](CoreV1Api.md#connectPostNodeProxy) | **POST** /api/v1/nodes/{name}/proxy | -[**connectPostNodeProxyWithPath**](CoreV1Api.md#connectPostNodeProxyWithPath) | **POST** /api/v1/nodes/{name}/proxy/{path} | -[**connectPutNamespacedPodProxy**](CoreV1Api.md#connectPutNamespacedPodProxy) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectPutNamespacedPodProxyWithPath**](CoreV1Api.md#connectPutNamespacedPodProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectPutNamespacedServiceProxy**](CoreV1Api.md#connectPutNamespacedServiceProxy) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectPutNamespacedServiceProxyWithPath**](CoreV1Api.md#connectPutNamespacedServiceProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectPutNodeProxy**](CoreV1Api.md#connectPutNodeProxy) | **PUT** /api/v1/nodes/{name}/proxy | -[**connectPutNodeProxyWithPath**](CoreV1Api.md#connectPutNodeProxyWithPath) | **PUT** /api/v1/nodes/{name}/proxy/{path} | -[**createNamespace**](CoreV1Api.md#createNamespace) | **POST** /api/v1/namespaces | -[**createNamespacedBinding**](CoreV1Api.md#createNamespacedBinding) | **POST** /api/v1/namespaces/{namespace}/bindings | -[**createNamespacedConfigMap**](CoreV1Api.md#createNamespacedConfigMap) | **POST** /api/v1/namespaces/{namespace}/configmaps | -[**createNamespacedEndpoints**](CoreV1Api.md#createNamespacedEndpoints) | **POST** /api/v1/namespaces/{namespace}/endpoints | -[**createNamespacedEvent**](CoreV1Api.md#createNamespacedEvent) | **POST** /api/v1/namespaces/{namespace}/events | -[**createNamespacedLimitRange**](CoreV1Api.md#createNamespacedLimitRange) | **POST** /api/v1/namespaces/{namespace}/limitranges | -[**createNamespacedPersistentVolumeClaim**](CoreV1Api.md#createNamespacedPersistentVolumeClaim) | **POST** /api/v1/namespaces/{namespace}/persistentvolumeclaims | -[**createNamespacedPod**](CoreV1Api.md#createNamespacedPod) | **POST** /api/v1/namespaces/{namespace}/pods | -[**createNamespacedPodBinding**](CoreV1Api.md#createNamespacedPodBinding) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/binding | -[**createNamespacedPodEviction**](CoreV1Api.md#createNamespacedPodEviction) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/eviction | -[**createNamespacedPodTemplate**](CoreV1Api.md#createNamespacedPodTemplate) | **POST** /api/v1/namespaces/{namespace}/podtemplates | -[**createNamespacedReplicationController**](CoreV1Api.md#createNamespacedReplicationController) | **POST** /api/v1/namespaces/{namespace}/replicationcontrollers | -[**createNamespacedResourceQuota**](CoreV1Api.md#createNamespacedResourceQuota) | **POST** /api/v1/namespaces/{namespace}/resourcequotas | -[**createNamespacedSecret**](CoreV1Api.md#createNamespacedSecret) | **POST** /api/v1/namespaces/{namespace}/secrets | -[**createNamespacedService**](CoreV1Api.md#createNamespacedService) | **POST** /api/v1/namespaces/{namespace}/services | -[**createNamespacedServiceAccount**](CoreV1Api.md#createNamespacedServiceAccount) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts | -[**createNamespacedServiceAccountToken**](CoreV1Api.md#createNamespacedServiceAccountToken) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token | -[**createNode**](CoreV1Api.md#createNode) | **POST** /api/v1/nodes | -[**createPersistentVolume**](CoreV1Api.md#createPersistentVolume) | **POST** /api/v1/persistentvolumes | -[**deleteCollectionNamespacedConfigMap**](CoreV1Api.md#deleteCollectionNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps | -[**deleteCollectionNamespacedEndpoints**](CoreV1Api.md#deleteCollectionNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints | -[**deleteCollectionNamespacedEvent**](CoreV1Api.md#deleteCollectionNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events | -[**deleteCollectionNamespacedLimitRange**](CoreV1Api.md#deleteCollectionNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges | -[**deleteCollectionNamespacedPersistentVolumeClaim**](CoreV1Api.md#deleteCollectionNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims | -[**deleteCollectionNamespacedPod**](CoreV1Api.md#deleteCollectionNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods | -[**deleteCollectionNamespacedPodTemplate**](CoreV1Api.md#deleteCollectionNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates | -[**deleteCollectionNamespacedReplicationController**](CoreV1Api.md#deleteCollectionNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers | -[**deleteCollectionNamespacedResourceQuota**](CoreV1Api.md#deleteCollectionNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas | -[**deleteCollectionNamespacedSecret**](CoreV1Api.md#deleteCollectionNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets | -[**deleteCollectionNamespacedService**](CoreV1Api.md#deleteCollectionNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services | -[**deleteCollectionNamespacedServiceAccount**](CoreV1Api.md#deleteCollectionNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts | -[**deleteCollectionNode**](CoreV1Api.md#deleteCollectionNode) | **DELETE** /api/v1/nodes | -[**deleteCollectionPersistentVolume**](CoreV1Api.md#deleteCollectionPersistentVolume) | **DELETE** /api/v1/persistentvolumes | -[**deleteNamespace**](CoreV1Api.md#deleteNamespace) | **DELETE** /api/v1/namespaces/{name} | -[**deleteNamespacedConfigMap**](CoreV1Api.md#deleteNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**deleteNamespacedEndpoints**](CoreV1Api.md#deleteNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**deleteNamespacedEvent**](CoreV1Api.md#deleteNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events/{name} | -[**deleteNamespacedLimitRange**](CoreV1Api.md#deleteNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**deleteNamespacedPersistentVolumeClaim**](CoreV1Api.md#deleteNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**deleteNamespacedPod**](CoreV1Api.md#deleteNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name} | -[**deleteNamespacedPodTemplate**](CoreV1Api.md#deleteNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**deleteNamespacedReplicationController**](CoreV1Api.md#deleteNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**deleteNamespacedResourceQuota**](CoreV1Api.md#deleteNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**deleteNamespacedSecret**](CoreV1Api.md#deleteNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets/{name} | -[**deleteNamespacedService**](CoreV1Api.md#deleteNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services/{name} | -[**deleteNamespacedServiceAccount**](CoreV1Api.md#deleteNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**deleteNode**](CoreV1Api.md#deleteNode) | **DELETE** /api/v1/nodes/{name} | -[**deletePersistentVolume**](CoreV1Api.md#deletePersistentVolume) | **DELETE** /api/v1/persistentvolumes/{name} | -[**getAPIResources**](CoreV1Api.md#getAPIResources) | **GET** /api/v1/ | -[**listComponentStatus**](CoreV1Api.md#listComponentStatus) | **GET** /api/v1/componentstatuses | -[**listConfigMapForAllNamespaces**](CoreV1Api.md#listConfigMapForAllNamespaces) | **GET** /api/v1/configmaps | -[**listEndpointsForAllNamespaces**](CoreV1Api.md#listEndpointsForAllNamespaces) | **GET** /api/v1/endpoints | -[**listEventForAllNamespaces**](CoreV1Api.md#listEventForAllNamespaces) | **GET** /api/v1/events | -[**listLimitRangeForAllNamespaces**](CoreV1Api.md#listLimitRangeForAllNamespaces) | **GET** /api/v1/limitranges | -[**listNamespace**](CoreV1Api.md#listNamespace) | **GET** /api/v1/namespaces | -[**listNamespacedConfigMap**](CoreV1Api.md#listNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps | -[**listNamespacedEndpoints**](CoreV1Api.md#listNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints | -[**listNamespacedEvent**](CoreV1Api.md#listNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events | -[**listNamespacedLimitRange**](CoreV1Api.md#listNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges | -[**listNamespacedPersistentVolumeClaim**](CoreV1Api.md#listNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims | -[**listNamespacedPod**](CoreV1Api.md#listNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods | -[**listNamespacedPodTemplate**](CoreV1Api.md#listNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates | -[**listNamespacedReplicationController**](CoreV1Api.md#listNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers | -[**listNamespacedResourceQuota**](CoreV1Api.md#listNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas | -[**listNamespacedSecret**](CoreV1Api.md#listNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets | -[**listNamespacedService**](CoreV1Api.md#listNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services | -[**listNamespacedServiceAccount**](CoreV1Api.md#listNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts | -[**listNode**](CoreV1Api.md#listNode) | **GET** /api/v1/nodes | -[**listPersistentVolume**](CoreV1Api.md#listPersistentVolume) | **GET** /api/v1/persistentvolumes | -[**listPersistentVolumeClaimForAllNamespaces**](CoreV1Api.md#listPersistentVolumeClaimForAllNamespaces) | **GET** /api/v1/persistentvolumeclaims | -[**listPodForAllNamespaces**](CoreV1Api.md#listPodForAllNamespaces) | **GET** /api/v1/pods | -[**listPodTemplateForAllNamespaces**](CoreV1Api.md#listPodTemplateForAllNamespaces) | **GET** /api/v1/podtemplates | -[**listReplicationControllerForAllNamespaces**](CoreV1Api.md#listReplicationControllerForAllNamespaces) | **GET** /api/v1/replicationcontrollers | -[**listResourceQuotaForAllNamespaces**](CoreV1Api.md#listResourceQuotaForAllNamespaces) | **GET** /api/v1/resourcequotas | -[**listSecretForAllNamespaces**](CoreV1Api.md#listSecretForAllNamespaces) | **GET** /api/v1/secrets | -[**listServiceAccountForAllNamespaces**](CoreV1Api.md#listServiceAccountForAllNamespaces) | **GET** /api/v1/serviceaccounts | -[**listServiceForAllNamespaces**](CoreV1Api.md#listServiceForAllNamespaces) | **GET** /api/v1/services | -[**patchNamespace**](CoreV1Api.md#patchNamespace) | **PATCH** /api/v1/namespaces/{name} | -[**patchNamespaceStatus**](CoreV1Api.md#patchNamespaceStatus) | **PATCH** /api/v1/namespaces/{name}/status | -[**patchNamespacedConfigMap**](CoreV1Api.md#patchNamespacedConfigMap) | **PATCH** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**patchNamespacedEndpoints**](CoreV1Api.md#patchNamespacedEndpoints) | **PATCH** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**patchNamespacedEvent**](CoreV1Api.md#patchNamespacedEvent) | **PATCH** /api/v1/namespaces/{namespace}/events/{name} | -[**patchNamespacedLimitRange**](CoreV1Api.md#patchNamespacedLimitRange) | **PATCH** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**patchNamespacedPersistentVolumeClaim**](CoreV1Api.md#patchNamespacedPersistentVolumeClaim) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**patchNamespacedPersistentVolumeClaimStatus**](CoreV1Api.md#patchNamespacedPersistentVolumeClaimStatus) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | -[**patchNamespacedPod**](CoreV1Api.md#patchNamespacedPod) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name} | -[**patchNamespacedPodEphemeralcontainers**](CoreV1Api.md#patchNamespacedPodEphemeralcontainers) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | -[**patchNamespacedPodResize**](CoreV1Api.md#patchNamespacedPodResize) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/resize | -[**patchNamespacedPodStatus**](CoreV1Api.md#patchNamespacedPodStatus) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/status | -[**patchNamespacedPodTemplate**](CoreV1Api.md#patchNamespacedPodTemplate) | **PATCH** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**patchNamespacedReplicationController**](CoreV1Api.md#patchNamespacedReplicationController) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**patchNamespacedReplicationControllerScale**](CoreV1Api.md#patchNamespacedReplicationControllerScale) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | -[**patchNamespacedReplicationControllerStatus**](CoreV1Api.md#patchNamespacedReplicationControllerStatus) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | -[**patchNamespacedResourceQuota**](CoreV1Api.md#patchNamespacedResourceQuota) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**patchNamespacedResourceQuotaStatus**](CoreV1Api.md#patchNamespacedResourceQuotaStatus) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | -[**patchNamespacedSecret**](CoreV1Api.md#patchNamespacedSecret) | **PATCH** /api/v1/namespaces/{namespace}/secrets/{name} | -[**patchNamespacedService**](CoreV1Api.md#patchNamespacedService) | **PATCH** /api/v1/namespaces/{namespace}/services/{name} | -[**patchNamespacedServiceAccount**](CoreV1Api.md#patchNamespacedServiceAccount) | **PATCH** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**patchNamespacedServiceStatus**](CoreV1Api.md#patchNamespacedServiceStatus) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/status | -[**patchNode**](CoreV1Api.md#patchNode) | **PATCH** /api/v1/nodes/{name} | -[**patchNodeStatus**](CoreV1Api.md#patchNodeStatus) | **PATCH** /api/v1/nodes/{name}/status | -[**patchPersistentVolume**](CoreV1Api.md#patchPersistentVolume) | **PATCH** /api/v1/persistentvolumes/{name} | -[**patchPersistentVolumeStatus**](CoreV1Api.md#patchPersistentVolumeStatus) | **PATCH** /api/v1/persistentvolumes/{name}/status | -[**readComponentStatus**](CoreV1Api.md#readComponentStatus) | **GET** /api/v1/componentstatuses/{name} | -[**readNamespace**](CoreV1Api.md#readNamespace) | **GET** /api/v1/namespaces/{name} | -[**readNamespaceStatus**](CoreV1Api.md#readNamespaceStatus) | **GET** /api/v1/namespaces/{name}/status | -[**readNamespacedConfigMap**](CoreV1Api.md#readNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**readNamespacedEndpoints**](CoreV1Api.md#readNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**readNamespacedEvent**](CoreV1Api.md#readNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events/{name} | -[**readNamespacedLimitRange**](CoreV1Api.md#readNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**readNamespacedPersistentVolumeClaim**](CoreV1Api.md#readNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**readNamespacedPersistentVolumeClaimStatus**](CoreV1Api.md#readNamespacedPersistentVolumeClaimStatus) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | -[**readNamespacedPod**](CoreV1Api.md#readNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods/{name} | -[**readNamespacedPodEphemeralcontainers**](CoreV1Api.md#readNamespacedPodEphemeralcontainers) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | -[**readNamespacedPodLog**](CoreV1Api.md#readNamespacedPodLog) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/log | -[**readNamespacedPodResize**](CoreV1Api.md#readNamespacedPodResize) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/resize | -[**readNamespacedPodStatus**](CoreV1Api.md#readNamespacedPodStatus) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/status | -[**readNamespacedPodTemplate**](CoreV1Api.md#readNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**readNamespacedReplicationController**](CoreV1Api.md#readNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**readNamespacedReplicationControllerScale**](CoreV1Api.md#readNamespacedReplicationControllerScale) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | -[**readNamespacedReplicationControllerStatus**](CoreV1Api.md#readNamespacedReplicationControllerStatus) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | -[**readNamespacedResourceQuota**](CoreV1Api.md#readNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**readNamespacedResourceQuotaStatus**](CoreV1Api.md#readNamespacedResourceQuotaStatus) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | -[**readNamespacedSecret**](CoreV1Api.md#readNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets/{name} | -[**readNamespacedService**](CoreV1Api.md#readNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services/{name} | -[**readNamespacedServiceAccount**](CoreV1Api.md#readNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**readNamespacedServiceStatus**](CoreV1Api.md#readNamespacedServiceStatus) | **GET** /api/v1/namespaces/{namespace}/services/{name}/status | -[**readNode**](CoreV1Api.md#readNode) | **GET** /api/v1/nodes/{name} | -[**readNodeStatus**](CoreV1Api.md#readNodeStatus) | **GET** /api/v1/nodes/{name}/status | -[**readPersistentVolume**](CoreV1Api.md#readPersistentVolume) | **GET** /api/v1/persistentvolumes/{name} | -[**readPersistentVolumeStatus**](CoreV1Api.md#readPersistentVolumeStatus) | **GET** /api/v1/persistentvolumes/{name}/status | -[**replaceNamespace**](CoreV1Api.md#replaceNamespace) | **PUT** /api/v1/namespaces/{name} | -[**replaceNamespaceFinalize**](CoreV1Api.md#replaceNamespaceFinalize) | **PUT** /api/v1/namespaces/{name}/finalize | -[**replaceNamespaceStatus**](CoreV1Api.md#replaceNamespaceStatus) | **PUT** /api/v1/namespaces/{name}/status | -[**replaceNamespacedConfigMap**](CoreV1Api.md#replaceNamespacedConfigMap) | **PUT** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**replaceNamespacedEndpoints**](CoreV1Api.md#replaceNamespacedEndpoints) | **PUT** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**replaceNamespacedEvent**](CoreV1Api.md#replaceNamespacedEvent) | **PUT** /api/v1/namespaces/{namespace}/events/{name} | -[**replaceNamespacedLimitRange**](CoreV1Api.md#replaceNamespacedLimitRange) | **PUT** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**replaceNamespacedPersistentVolumeClaim**](CoreV1Api.md#replaceNamespacedPersistentVolumeClaim) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**replaceNamespacedPersistentVolumeClaimStatus**](CoreV1Api.md#replaceNamespacedPersistentVolumeClaimStatus) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | -[**replaceNamespacedPod**](CoreV1Api.md#replaceNamespacedPod) | **PUT** /api/v1/namespaces/{namespace}/pods/{name} | -[**replaceNamespacedPodEphemeralcontainers**](CoreV1Api.md#replaceNamespacedPodEphemeralcontainers) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | -[**replaceNamespacedPodResize**](CoreV1Api.md#replaceNamespacedPodResize) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/resize | -[**replaceNamespacedPodStatus**](CoreV1Api.md#replaceNamespacedPodStatus) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/status | -[**replaceNamespacedPodTemplate**](CoreV1Api.md#replaceNamespacedPodTemplate) | **PUT** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**replaceNamespacedReplicationController**](CoreV1Api.md#replaceNamespacedReplicationController) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**replaceNamespacedReplicationControllerScale**](CoreV1Api.md#replaceNamespacedReplicationControllerScale) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | -[**replaceNamespacedReplicationControllerStatus**](CoreV1Api.md#replaceNamespacedReplicationControllerStatus) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | -[**replaceNamespacedResourceQuota**](CoreV1Api.md#replaceNamespacedResourceQuota) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**replaceNamespacedResourceQuotaStatus**](CoreV1Api.md#replaceNamespacedResourceQuotaStatus) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | -[**replaceNamespacedSecret**](CoreV1Api.md#replaceNamespacedSecret) | **PUT** /api/v1/namespaces/{namespace}/secrets/{name} | -[**replaceNamespacedService**](CoreV1Api.md#replaceNamespacedService) | **PUT** /api/v1/namespaces/{namespace}/services/{name} | -[**replaceNamespacedServiceAccount**](CoreV1Api.md#replaceNamespacedServiceAccount) | **PUT** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**replaceNamespacedServiceStatus**](CoreV1Api.md#replaceNamespacedServiceStatus) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/status | -[**replaceNode**](CoreV1Api.md#replaceNode) | **PUT** /api/v1/nodes/{name} | -[**replaceNodeStatus**](CoreV1Api.md#replaceNodeStatus) | **PUT** /api/v1/nodes/{name}/status | -[**replacePersistentVolume**](CoreV1Api.md#replacePersistentVolume) | **PUT** /api/v1/persistentvolumes/{name} | -[**replacePersistentVolumeStatus**](CoreV1Api.md#replacePersistentVolumeStatus) | **PUT** /api/v1/persistentvolumes/{name}/status | - - -# **connectDeleteNamespacedPodProxy** -> string connectDeleteNamespacedPodProxy() - -connect DELETE requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectDeleteNamespacedPodProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectDeleteNamespacedPodProxyWithPath** -> string connectDeleteNamespacedPodProxyWithPath() - -connect DELETE requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectDeleteNamespacedServiceProxy** -> string connectDeleteNamespacedServiceProxy() - -connect DELETE requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectDeleteNamespacedServiceProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectDeleteNamespacedServiceProxyWithPath** -> string connectDeleteNamespacedServiceProxyWithPath() - -connect DELETE requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectDeleteNodeProxy** -> string connectDeleteNodeProxy() - -connect DELETE requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectDeleteNodeProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectDeleteNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectDeleteNodeProxyWithPath** -> string connectDeleteNodeProxyWithPath() - -connect DELETE requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectDeleteNodeProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectDeleteNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectGetNamespacedPodAttach** -> string connectGetNamespacedPodAttach() - -connect GET requests to attach of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectGetNamespacedPodAttachRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodAttachRequest = { - // name of the PodAttachOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) - stderr: true, - // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectGetNamespacedPodAttach(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodAttachOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectGetNamespacedPodExec** -> string connectGetNamespacedPodExec() - -connect GET requests to exec of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectGetNamespacedPodExecRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodExecRequest = { - // name of the PodExecOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Command is the remote command to execute. argv array. Not executed within a shell. (optional) - command: "command_example", - // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Redirect the standard error stream of the pod for this call. (optional) - stderr: true, - // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Redirect the standard output stream of the pod for this call. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectGetNamespacedPodExec(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodExecOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined - **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined - **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectGetNamespacedPodPortforward** -> string connectGetNamespacedPodPortforward() - -connect GET requests to portforward of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectGetNamespacedPodPortforwardRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodPortforwardRequest = { - // name of the PodPortForwardOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // List of ports to forward Required when using WebSockets (optional) - ports: 1, -}; - -const data = await apiInstance.connectGetNamespacedPodPortforward(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectGetNamespacedPodProxy** -> string connectGetNamespacedPodProxy() - -connect GET requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectGetNamespacedPodProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectGetNamespacedPodProxyWithPath** -> string connectGetNamespacedPodProxyWithPath() - -connect GET requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectGetNamespacedServiceProxy** -> string connectGetNamespacedServiceProxy() - -connect GET requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectGetNamespacedServiceProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectGetNamespacedServiceProxyWithPath** -> string connectGetNamespacedServiceProxyWithPath() - -connect GET requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectGetNodeProxy** -> string connectGetNodeProxy() - -connect GET requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectGetNodeProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectGetNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectGetNodeProxyWithPath** -> string connectGetNodeProxyWithPath() - -connect GET requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectGetNodeProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectGetNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectHeadNamespacedPodProxy** -> string connectHeadNamespacedPodProxy() - -connect HEAD requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectHeadNamespacedPodProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectHeadNamespacedPodProxyWithPath** -> string connectHeadNamespacedPodProxyWithPath() - -connect HEAD requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectHeadNamespacedServiceProxy** -> string connectHeadNamespacedServiceProxy() - -connect HEAD requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectHeadNamespacedServiceProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectHeadNamespacedServiceProxyWithPath** -> string connectHeadNamespacedServiceProxyWithPath() - -connect HEAD requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectHeadNodeProxy** -> string connectHeadNodeProxy() - -connect HEAD requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectHeadNodeProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectHeadNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectHeadNodeProxyWithPath** -> string connectHeadNodeProxyWithPath() - -connect HEAD requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectHeadNodeProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectHeadNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectOptionsNamespacedPodProxy** -> string connectOptionsNamespacedPodProxy() - -connect OPTIONS requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectOptionsNamespacedPodProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectOptionsNamespacedPodProxyWithPath** -> string connectOptionsNamespacedPodProxyWithPath() - -connect OPTIONS requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectOptionsNamespacedServiceProxy** -> string connectOptionsNamespacedServiceProxy() - -connect OPTIONS requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectOptionsNamespacedServiceProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectOptionsNamespacedServiceProxyWithPath** -> string connectOptionsNamespacedServiceProxyWithPath() - -connect OPTIONS requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectOptionsNodeProxy** -> string connectOptionsNodeProxy() - -connect OPTIONS requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectOptionsNodeProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectOptionsNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectOptionsNodeProxyWithPath** -> string connectOptionsNodeProxyWithPath() - -connect OPTIONS requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectOptionsNodeProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectOptionsNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPatchNamespacedPodProxy** -> string connectPatchNamespacedPodProxy() - -connect PATCH requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPatchNamespacedPodProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPatchNamespacedPodProxyWithPath** -> string connectPatchNamespacedPodProxyWithPath() - -connect PATCH requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPatchNamespacedServiceProxy** -> string connectPatchNamespacedServiceProxy() - -connect PATCH requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPatchNamespacedServiceProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPatchNamespacedServiceProxyWithPath** -> string connectPatchNamespacedServiceProxyWithPath() - -connect PATCH requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPatchNodeProxy** -> string connectPatchNodeProxy() - -connect PATCH requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPatchNodeProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPatchNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPatchNodeProxyWithPath** -> string connectPatchNodeProxyWithPath() - -connect PATCH requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPatchNodeProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPatchNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPostNamespacedPodAttach** -> string connectPostNamespacedPodAttach() - -connect POST requests to attach of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPostNamespacedPodAttachRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodAttachRequest = { - // name of the PodAttachOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) - stderr: true, - // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectPostNamespacedPodAttach(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodAttachOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPostNamespacedPodExec** -> string connectPostNamespacedPodExec() - -connect POST requests to exec of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPostNamespacedPodExecRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodExecRequest = { - // name of the PodExecOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Command is the remote command to execute. argv array. Not executed within a shell. (optional) - command: "command_example", - // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Redirect the standard error stream of the pod for this call. (optional) - stderr: true, - // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Redirect the standard output stream of the pod for this call. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectPostNamespacedPodExec(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodExecOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined - **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined - **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPostNamespacedPodPortforward** -> string connectPostNamespacedPodPortforward() - -connect POST requests to portforward of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPostNamespacedPodPortforwardRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodPortforwardRequest = { - // name of the PodPortForwardOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // List of ports to forward Required when using WebSockets (optional) - ports: 1, -}; - -const data = await apiInstance.connectPostNamespacedPodPortforward(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPostNamespacedPodProxy** -> string connectPostNamespacedPodProxy() - -connect POST requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPostNamespacedPodProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPostNamespacedPodProxyWithPath** -> string connectPostNamespacedPodProxyWithPath() - -connect POST requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPostNamespacedServiceProxy** -> string connectPostNamespacedServiceProxy() - -connect POST requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPostNamespacedServiceProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPostNamespacedServiceProxyWithPath** -> string connectPostNamespacedServiceProxyWithPath() - -connect POST requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPostNodeProxy** -> string connectPostNodeProxy() - -connect POST requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPostNodeProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPostNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPostNodeProxyWithPath** -> string connectPostNodeProxyWithPath() - -connect POST requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPostNodeProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPostNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPutNamespacedPodProxy** -> string connectPutNamespacedPodProxy() - -connect PUT requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPutNamespacedPodProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPutNamespacedPodProxyWithPath** -> string connectPutNamespacedPodProxyWithPath() - -connect PUT requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPutNamespacedServiceProxy** -> string connectPutNamespacedServiceProxy() - -connect PUT requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPutNamespacedServiceProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPutNamespacedServiceProxyWithPath** -> string connectPutNamespacedServiceProxyWithPath() - -connect PUT requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPutNodeProxy** -> string connectPutNodeProxy() - -connect PUT requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPutNodeProxyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPutNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **connectPutNodeProxyWithPath** -> string connectPutNodeProxyWithPath() - -connect PUT requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiConnectPutNodeProxyWithPathRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPutNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespace** -> V1Namespace createNamespace(body) - -create a Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespaceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespaceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Namespace** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedBinding** -> V1Binding createNamespacedBinding(body) - -create a Binding - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - target: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Binding**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Binding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedConfigMap** -> V1ConfigMap createNamespacedConfigMap(body) - -create a ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedConfigMapRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedConfigMapRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - binaryData: { - "key": 'YQ==', - }, - data: { - "key": "key_example", - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ConfigMap**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ConfigMap** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedEndpoints** -> V1Endpoints createNamespacedEndpoints(body) - -create Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedEndpointsRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedEndpointsRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - subsets: [ - { - addresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - notReadyAddresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Endpoints**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Endpoints** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedEvent** -> CoreV1Event createNamespacedEvent(body) - -create an Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - count: 1, - eventTime: "eventTime_example", - firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - involvedObject: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - kind: "kind_example", - lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - reason: "reason_example", - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingComponent: "reportingComponent_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - source: { - component: "component_example", - host: "host_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **CoreV1Event**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**CoreV1Event** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedLimitRange** -> V1LimitRange createNamespacedLimitRange(body) - -create a LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedLimitRangeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedLimitRangeRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - limits: [ - { - _default: { - "key": "key_example", - }, - defaultRequest: { - "key": "key_example", - }, - max: { - "key": "key_example", - }, - maxLimitRequestRatio: { - "key": "key_example", - }, - min: { - "key": "key_example", - }, - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1LimitRange**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1LimitRange** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedPersistentVolumeClaim** -> V1PersistentVolumeClaim createNamespacedPersistentVolumeClaim(body) - -create a PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolumeClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedPod** -> V1Pod createNamespacedPod(body) - -create a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedPodRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedPodBinding** -> V1Binding createNamespacedPodBinding(body) - -create binding of a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedPodBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodBindingRequest = { - // name of the Binding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - target: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedPodBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Binding**| | - **name** | [**string**] | name of the Binding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Binding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedPodEviction** -> V1Eviction createNamespacedPodEviction(body) - -create eviction of a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedPodEvictionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodEvictionRequest = { - // name of the Eviction - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - deleteOptions: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedPodEviction(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Eviction**| | - **name** | [**string**] | name of the Eviction | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Eviction** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedPodTemplate** -> V1PodTemplate createNamespacedPodTemplate(body) - -create a PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedPodTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PodTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedReplicationController** -> V1ReplicationController createNamespacedReplicationController(body) - -create a ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedReplicationControllerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedReplicationControllerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - "key": "key_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicationController**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ReplicationController** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceQuota** -> V1ResourceQuota createNamespacedResourceQuota(body) - -create a ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedResourceQuotaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedResourceQuotaRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - hard: { - "key": "key_example", - }, - scopeSelector: { - matchExpressions: [ - { - operator: "operator_example", - scopeName: "scopeName_example", - values: [ - "values_example", - ], - }, - ], - }, - scopes: [ - "scopes_example", - ], - }, - status: { - hard: { - "key": "key_example", - }, - used: { - "key": "key_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceQuota**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ResourceQuota** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedSecret** -> V1Secret createNamespacedSecret(body) - -create a Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedSecretRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedSecretRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: { - "key": 'YQ==', - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - stringData: { - "key": "key_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Secret**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Secret** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedService** -> V1Service createNamespacedService(body) - -create a Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedServiceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocateLoadBalancerNodePorts: true, - clusterIP: "clusterIP_example", - clusterIPs: [ - "clusterIPs_example", - ], - externalIPs: [ - "externalIPs_example", - ], - externalName: "externalName_example", - externalTrafficPolicy: "externalTrafficPolicy_example", - healthCheckNodePort: 1, - internalTrafficPolicy: "internalTrafficPolicy_example", - ipFamilies: [ - "ipFamilies_example", - ], - ipFamilyPolicy: "ipFamilyPolicy_example", - loadBalancerClass: "loadBalancerClass_example", - loadBalancerIP: "loadBalancerIP_example", - loadBalancerSourceRanges: [ - "loadBalancerSourceRanges_example", - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - nodePort: 1, - port: 1, - protocol: "protocol_example", - targetPort: "targetPort_example", - }, - ], - publishNotReadyAddresses: true, - selector: { - "key": "key_example", - }, - sessionAffinity: "sessionAffinity_example", - sessionAffinityConfig: { - clientIP: { - timeoutSeconds: 1, - }, - }, - trafficDistribution: "trafficDistribution_example", - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ipMode: "ipMode_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Service**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Service** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedServiceAccount** -> V1ServiceAccount createNamespacedServiceAccount(body) - -create a ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedServiceAccountRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedServiceAccountRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - automountServiceAccountToken: true, - imagePullSecrets: [ - { - name: "name_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - secrets: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceAccount**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ServiceAccount** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedServiceAccountToken** -> AuthenticationV1TokenRequest createNamespacedServiceAccountToken(body) - -create token of a ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNamespacedServiceAccountTokenRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedServiceAccountTokenRequest = { - // name of the TokenRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - audiences: [ - "audiences_example", - ], - boundObjectRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - expirationSeconds: 1, - }, - status: { - expirationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - token: "token_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedServiceAccountToken(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **AuthenticationV1TokenRequest**| | - **name** | [**string**] | name of the TokenRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**AuthenticationV1TokenRequest** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNode** -> V1Node createNode(body) - -create a Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreateNodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNodeRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - configSource: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - externalID: "externalID_example", - podCIDR: "podCIDR_example", - podCIDRs: [ - "podCIDRs_example", - ], - providerID: "providerID_example", - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - unschedulable: true, - }, - status: { - addresses: [ - { - address: "address_example", - type: "type_example", - }, - ], - allocatable: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - config: { - active: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - assigned: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - error: "error_example", - lastKnownGood: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - }, - daemonEndpoints: { - kubeletEndpoint: { - Port: 1, - }, - }, - declaredFeatures: [ - "declaredFeatures_example", - ], - features: { - supplementalGroupsPolicy: true, - }, - images: [ - { - names: [ - "names_example", - ], - sizeBytes: 1, - }, - ], - nodeInfo: { - architecture: "architecture_example", - bootID: "bootID_example", - containerRuntimeVersion: "containerRuntimeVersion_example", - kernelVersion: "kernelVersion_example", - kubeProxyVersion: "kubeProxyVersion_example", - kubeletVersion: "kubeletVersion_example", - machineID: "machineID_example", - operatingSystem: "operatingSystem_example", - osImage: "osImage_example", - swap: { - capacity: 1, - }, - systemUUID: "systemUUID_example", - }, - phase: "phase_example", - runtimeHandlers: [ - { - features: { - recursiveReadOnlyMounts: true, - userNamespaces: true, - }, - name: "name_example", - }, - ], - volumesAttached: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumesInUse: [ - "volumesInUse_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Node**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Node** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createPersistentVolume** -> V1PersistentVolume createPersistentVolume(body) - -create a PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiCreatePersistentVolumeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreatePersistentVolumeRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - status: { - lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - phase: "phase_example", - reason: "reason_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolume**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolume** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedConfigMap** -> V1Status deleteCollectionNamespacedConfigMap() - -delete collection of ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedConfigMapRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedConfigMapRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedEndpoints** -> V1Status deleteCollectionNamespacedEndpoints() - -delete collection of Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedEndpointsRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedEndpointsRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedEvent** -> V1Status deleteCollectionNamespacedEvent() - -delete collection of Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedLimitRange** -> V1Status deleteCollectionNamespacedLimitRange() - -delete collection of LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedPersistentVolumeClaim** -> V1Status deleteCollectionNamespacedPersistentVolumeClaim() - -delete collection of PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedPod** -> V1Status deleteCollectionNamespacedPod() - -delete collection of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedPodRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedPodRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedPodTemplate** -> V1Status deleteCollectionNamespacedPodTemplate() - -delete collection of PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedReplicationController** -> V1Status deleteCollectionNamespacedReplicationController() - -delete collection of ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceQuota** -> V1Status deleteCollectionNamespacedResourceQuota() - -delete collection of ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedSecret** -> V1Status deleteCollectionNamespacedSecret() - -delete collection of Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedSecretRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedSecretRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedService** -> V1Status deleteCollectionNamespacedService() - -delete collection of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedServiceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedServiceAccount** -> V1Status deleteCollectionNamespacedServiceAccount() - -delete collection of ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNode** -> V1Status deleteCollectionNode() - -delete collection of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionNodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionPersistentVolume** -> V1Status deleteCollectionPersistentVolume() - -delete collection of PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteCollectionPersistentVolumeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionPersistentVolumeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespace** -> V1Status deleteNamespace() - -delete a Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespaceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespaceRequest = { - // name of the Namespace - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedConfigMap** -> V1Status deleteNamespacedConfigMap() - -delete a ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedConfigMapRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedEndpoints** -> V1Status deleteNamespacedEndpoints() - -delete Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedEndpointsRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedEvent** -> V1Status deleteNamespacedEvent() - -delete an Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedLimitRange** -> V1Status deleteNamespacedLimitRange() - -delete a LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedLimitRangeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedPersistentVolumeClaim** -> V1PersistentVolumeClaim deleteNamespacedPersistentVolumeClaim() - -delete a PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedPod** -> V1Pod deleteNamespacedPod() - -delete a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedPodRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedPodTemplate** -> V1PodTemplate deleteNamespacedPodTemplate() - -delete a PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedPodTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1PodTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedReplicationController** -> V1Status deleteNamespacedReplicationController() - -delete a ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedReplicationControllerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceQuota** -> V1ResourceQuota deleteNamespacedResourceQuota() - -delete a ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedResourceQuotaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1ResourceQuota** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedSecret** -> V1Status deleteNamespacedSecret() - -delete a Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedSecretRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedService** -> V1Service deleteNamespacedService() - -delete a Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Service** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedServiceAccount** -> V1ServiceAccount deleteNamespacedServiceAccount() - -delete a ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNamespacedServiceAccountRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1ServiceAccount** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNode** -> V1Status deleteNode() - -delete a Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeleteNodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNodeRequest = { - // name of the Node - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deletePersistentVolume** -> V1PersistentVolume deletePersistentVolume() - -delete a PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiDeletePersistentVolumeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeletePersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deletePersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolume** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listComponentStatus** -> V1ComponentStatusList listComponentStatus() - -list objects of kind ComponentStatus - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListComponentStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListComponentStatusRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listComponentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ComponentStatusList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listConfigMapForAllNamespaces** -> V1ConfigMapList listConfigMapForAllNamespaces() - -list or watch objects of kind ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListConfigMapForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListConfigMapForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listConfigMapForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ConfigMapList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listEndpointsForAllNamespaces** -> V1EndpointsList listEndpointsForAllNamespaces() - -list or watch objects of kind Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListEndpointsForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListEndpointsForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEndpointsForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1EndpointsList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listEventForAllNamespaces** -> CoreV1EventList listEventForAllNamespaces() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListEventForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListEventForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEventForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**CoreV1EventList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listLimitRangeForAllNamespaces** -> V1LimitRangeList listLimitRangeForAllNamespaces() - -list or watch objects of kind LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListLimitRangeForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListLimitRangeForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLimitRangeForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1LimitRangeList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespace** -> V1NamespaceList listNamespace() - -list or watch objects of kind Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespaceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespaceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1NamespaceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedConfigMap** -> V1ConfigMapList listNamespacedConfigMap() - -list or watch objects of kind ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedConfigMapRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedConfigMapRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ConfigMapList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedEndpoints** -> V1EndpointsList listNamespacedEndpoints() - -list or watch objects of kind Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedEndpointsRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedEndpointsRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1EndpointsList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedEvent** -> CoreV1EventList listNamespacedEvent() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**CoreV1EventList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedLimitRange** -> V1LimitRangeList listNamespacedLimitRange() - -list or watch objects of kind LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedLimitRangeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedLimitRangeRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1LimitRangeList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedPersistentVolumeClaim** -> V1PersistentVolumeClaimList listNamespacedPersistentVolumeClaim() - -list or watch objects of kind PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedPersistentVolumeClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedPersistentVolumeClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeClaimList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedPod** -> V1PodList listNamespacedPod() - -list or watch objects of kind Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedPodRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedPodRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PodList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedPodTemplate** -> V1PodTemplateList listNamespacedPodTemplate() - -list or watch objects of kind PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedPodTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedPodTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PodTemplateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedReplicationController** -> V1ReplicationControllerList listNamespacedReplicationController() - -list or watch objects of kind ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedReplicationControllerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedReplicationControllerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ReplicationControllerList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceQuota** -> V1ResourceQuotaList listNamespacedResourceQuota() - -list or watch objects of kind ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedResourceQuotaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedResourceQuotaRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ResourceQuotaList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedSecret** -> V1SecretList listNamespacedSecret() - -list or watch objects of kind Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedSecretRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedSecretRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1SecretList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedService** -> V1ServiceList listNamespacedService() - -list or watch objects of kind Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedServiceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ServiceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedServiceAccount** -> V1ServiceAccountList listNamespacedServiceAccount() - -list or watch objects of kind ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNamespacedServiceAccountRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedServiceAccountRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ServiceAccountList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNode** -> V1NodeList listNode() - -list or watch objects of kind Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListNodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1NodeList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listPersistentVolume** -> V1PersistentVolumeList listPersistentVolume() - -list or watch objects of kind PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListPersistentVolumeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPersistentVolumeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listPersistentVolumeClaimForAllNamespaces** -> V1PersistentVolumeClaimList listPersistentVolumeClaimForAllNamespaces() - -list or watch objects of kind PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPersistentVolumeClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeClaimList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listPodForAllNamespaces** -> V1PodList listPodForAllNamespaces() - -list or watch objects of kind Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListPodForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPodForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PodList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listPodTemplateForAllNamespaces** -> V1PodTemplateList listPodTemplateForAllNamespaces() - -list or watch objects of kind PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListPodTemplateForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPodTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PodTemplateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listReplicationControllerForAllNamespaces** -> V1ReplicationControllerList listReplicationControllerForAllNamespaces() - -list or watch objects of kind ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListReplicationControllerForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListReplicationControllerForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listReplicationControllerForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ReplicationControllerList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceQuotaForAllNamespaces** -> V1ResourceQuotaList listResourceQuotaForAllNamespaces() - -list or watch objects of kind ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListResourceQuotaForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListResourceQuotaForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceQuotaForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ResourceQuotaList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listSecretForAllNamespaces** -> V1SecretList listSecretForAllNamespaces() - -list or watch objects of kind Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListSecretForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListSecretForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listSecretForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1SecretList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listServiceAccountForAllNamespaces** -> V1ServiceAccountList listServiceAccountForAllNamespaces() - -list or watch objects of kind ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListServiceAccountForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListServiceAccountForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceAccountForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ServiceAccountList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listServiceForAllNamespaces** -> V1ServiceList listServiceForAllNamespaces() - -list or watch objects of kind Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiListServiceForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListServiceForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ServiceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespace** -> V1Namespace patchNamespace(body) - -partially update the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespaceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespaceRequest = { - // name of the Namespace - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Namespace** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespaceStatus** -> V1Namespace patchNamespaceStatus(body) - -partially update status of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespaceStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespaceStatusRequest = { - // name of the Namespace - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespaceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Namespace** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedConfigMap** -> V1ConfigMap patchNamespacedConfigMap(body) - -partially update the specified ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedConfigMapRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ConfigMap** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedEndpoints** -> V1Endpoints patchNamespacedEndpoints(body) - -partially update the specified Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedEndpointsRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Endpoints** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedEvent** -> CoreV1Event patchNamespacedEvent(body) - -partially update the specified Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**CoreV1Event** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedLimitRange** -> V1LimitRange patchNamespacedLimitRange(body) - -partially update the specified LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedLimitRangeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1LimitRange** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPersistentVolumeClaim** -> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaim(body) - -partially update the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPersistentVolumeClaimStatus** -> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaimStatus(body) - -partially update status of the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPersistentVolumeClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPod** -> V1Pod patchNamespacedPod(body) - -partially update the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedPodRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPodEphemeralcontainers** -> V1Pod patchNamespacedPodEphemeralcontainers(body) - -partially update ephemeralcontainers of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodEphemeralcontainers(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPodResize** -> V1Pod patchNamespacedPodResize(body) - -partially update resize of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedPodResizeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodResizeRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodResize(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPodStatus** -> V1Pod patchNamespacedPodStatus(body) - -partially update status of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedPodStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodStatusRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPodTemplate** -> V1PodTemplate patchNamespacedPodTemplate(body) - -partially update the specified PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedPodTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1PodTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedReplicationController** -> V1ReplicationController patchNamespacedReplicationController(body) - -partially update the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedReplicationControllerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ReplicationController** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedReplicationControllerScale** -> V1Scale patchNamespacedReplicationControllerScale(body) - -partially update scale of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedReplicationControllerScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedReplicationControllerScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicationControllerScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedReplicationControllerStatus** -> V1ReplicationController patchNamespacedReplicationControllerStatus(body) - -partially update status of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedReplicationControllerStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedReplicationControllerStatusRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicationControllerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ReplicationController** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceQuota** -> V1ResourceQuota patchNamespacedResourceQuota(body) - -partially update the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedResourceQuotaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ResourceQuota** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceQuotaStatus** -> V1ResourceQuota patchNamespacedResourceQuotaStatus(body) - -partially update status of the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedResourceQuotaStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedResourceQuotaStatusRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceQuotaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ResourceQuota** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedSecret** -> V1Secret patchNamespacedSecret(body) - -partially update the specified Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedSecretRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Secret** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedService** -> V1Service patchNamespacedService(body) - -partially update the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Service** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedServiceAccount** -> V1ServiceAccount patchNamespacedServiceAccount(body) - -partially update the specified ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedServiceAccountRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ServiceAccount** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedServiceStatus** -> V1Service patchNamespacedServiceStatus(body) - -partially update status of the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNamespacedServiceStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedServiceStatusRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Service** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNode** -> V1Node patchNode(body) - -partially update the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNodeRequest = { - // name of the Node - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Node** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNodeStatus** -> V1Node patchNodeStatus(body) - -partially update status of the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchNodeStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNodeStatusRequest = { - // name of the Node - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNodeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Node** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchPersistentVolume** -> V1PersistentVolume patchPersistentVolume(body) - -partially update the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchPersistentVolumeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchPersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolume** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchPersistentVolumeStatus** -> V1PersistentVolume patchPersistentVolumeStatus(body) - -partially update status of the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiPatchPersistentVolumeStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchPersistentVolumeStatusRequest = { - // name of the PersistentVolume - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPersistentVolumeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolume** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readComponentStatus** -> V1ComponentStatus readComponentStatus() - -read the specified ComponentStatus - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadComponentStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadComponentStatusRequest = { - // name of the ComponentStatus - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readComponentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ComponentStatus | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ComponentStatus** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespace** -> V1Namespace readNamespace() - -read the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespaceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespaceRequest = { - // name of the Namespace - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Namespace** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespaceStatus** -> V1Namespace readNamespaceStatus() - -read status of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespaceStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespaceStatusRequest = { - // name of the Namespace - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespaceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Namespace** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedConfigMap** -> V1ConfigMap readNamespacedConfigMap() - -read the specified ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedConfigMapRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ConfigMap** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedEndpoints** -> V1Endpoints readNamespacedEndpoints() - -read the specified Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedEndpointsRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Endpoints** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedEvent** -> CoreV1Event readNamespacedEvent() - -read the specified Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**CoreV1Event** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedLimitRange** -> V1LimitRange readNamespacedLimitRange() - -read the specified LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedLimitRangeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1LimitRange** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPersistentVolumeClaim** -> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaim() - -read the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedPersistentVolumeClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPersistentVolumeClaimStatus** -> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaimStatus() - -read status of the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPersistentVolumeClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPod** -> V1Pod readNamespacedPod() - -read the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedPodRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodEphemeralcontainers** -> V1Pod readNamespacedPodEphemeralcontainers() - -read ephemeralcontainers of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedPodEphemeralcontainersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodEphemeralcontainersRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodEphemeralcontainers(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodLog** -> string readNamespacedPodLog() - -read log of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedPodLogRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodLogRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // The container for which to stream logs. Defaults to only container if there is one container in the pod. (optional) - container: "container_example", - // Follow the log stream of the pod. Defaults to false. (optional) - follow: true, - // insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). (optional) - insecureSkipTLSVerifyBackend: true, - // If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. (optional) - limitBytes: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // Return previous terminated container logs. Defaults to false. (optional) - previous: true, - // A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. (optional) - sinceSeconds: 1, - // Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) - stream: "stream_example", - // If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) - tailLines: 1, - // If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. (optional) - timestamps: true, -}; - -const data = await apiInstance.readNamespacedPodLog(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **container** | [**string**] | The container for which to stream logs. Defaults to only container if there is one container in the pod. | (optional) defaults to undefined - **follow** | [**boolean**] | Follow the log stream of the pod. Defaults to false. | (optional) defaults to undefined - **insecureSkipTLSVerifyBackend** | [**boolean**] | insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). | (optional) defaults to undefined - **limitBytes** | [**number**] | If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **previous** | [**boolean**] | Return previous terminated container logs. Defaults to false. | (optional) defaults to undefined - **sinceSeconds** | [**number**] | A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. | (optional) defaults to undefined - **stream** | [**string**] | Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined - **tailLines** | [**number**] | If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined - **timestamps** | [**boolean**] | If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. | (optional) defaults to undefined - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodResize** -> V1Pod readNamespacedPodResize() - -read resize of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedPodResizeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodResizeRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodResize(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodStatus** -> V1Pod readNamespacedPodStatus() - -read status of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedPodStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodStatusRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodTemplate** -> V1PodTemplate readNamespacedPodTemplate() - -read the specified PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedPodTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1PodTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedReplicationController** -> V1ReplicationController readNamespacedReplicationController() - -read the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedReplicationControllerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ReplicationController** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedReplicationControllerScale** -> V1Scale readNamespacedReplicationControllerScale() - -read scale of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedReplicationControllerScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedReplicationControllerScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicationControllerScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedReplicationControllerStatus** -> V1ReplicationController readNamespacedReplicationControllerStatus() - -read status of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedReplicationControllerStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedReplicationControllerStatusRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicationControllerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ReplicationController** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceQuota** -> V1ResourceQuota readNamespacedResourceQuota() - -read the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedResourceQuotaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ResourceQuota** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceQuotaStatus** -> V1ResourceQuota readNamespacedResourceQuotaStatus() - -read status of the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedResourceQuotaStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedResourceQuotaStatusRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceQuotaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ResourceQuota** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedSecret** -> V1Secret readNamespacedSecret() - -read the specified Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedSecretRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Secret** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedService** -> V1Service readNamespacedService() - -read the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Service** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedServiceAccount** -> V1ServiceAccount readNamespacedServiceAccount() - -read the specified ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedServiceAccountRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ServiceAccount** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedServiceStatus** -> V1Service readNamespacedServiceStatus() - -read status of the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNamespacedServiceStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedServiceStatusRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Service** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNode** -> V1Node readNode() - -read the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNodeRequest = { - // name of the Node - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Node** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNodeStatus** -> V1Node readNodeStatus() - -read status of the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadNodeStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNodeStatusRequest = { - // name of the Node - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNodeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Node** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readPersistentVolume** -> V1PersistentVolume readPersistentVolume() - -read the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadPersistentVolumeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadPersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolume** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readPersistentVolumeStatus** -> V1PersistentVolume readPersistentVolumeStatus() - -read status of the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReadPersistentVolumeStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadPersistentVolumeStatusRequest = { - // name of the PersistentVolume - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPersistentVolumeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolume** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespace** -> V1Namespace replaceNamespace(body) - -replace the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespaceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespaceRequest = { - // name of the Namespace - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Namespace** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespaceFinalize** -> V1Namespace replaceNamespaceFinalize(body) - -replace finalize of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespaceFinalizeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespaceFinalizeRequest = { - // name of the Namespace - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.replaceNamespaceFinalize(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Namespace** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespaceStatus** -> V1Namespace replaceNamespaceStatus(body) - -replace status of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespaceStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespaceStatusRequest = { - // name of the Namespace - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespaceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Namespace** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedConfigMap** -> V1ConfigMap replaceNamespacedConfigMap(body) - -replace the specified ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedConfigMapRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - binaryData: { - "key": 'YQ==', - }, - data: { - "key": "key_example", - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ConfigMap**| | - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ConfigMap** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedEndpoints** -> V1Endpoints replaceNamespacedEndpoints(body) - -replace the specified Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedEndpointsRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - subsets: [ - { - addresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - notReadyAddresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Endpoints**| | - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Endpoints** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedEvent** -> CoreV1Event replaceNamespacedEvent(body) - -replace the specified Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - count: 1, - eventTime: "eventTime_example", - firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - involvedObject: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - kind: "kind_example", - lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - reason: "reason_example", - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingComponent: "reportingComponent_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - source: { - component: "component_example", - host: "host_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **CoreV1Event**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**CoreV1Event** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedLimitRange** -> V1LimitRange replaceNamespacedLimitRange(body) - -replace the specified LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedLimitRangeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - limits: [ - { - _default: { - "key": "key_example", - }, - defaultRequest: { - "key": "key_example", - }, - max: { - "key": "key_example", - }, - maxLimitRequestRatio: { - "key": "key_example", - }, - min: { - "key": "key_example", - }, - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1LimitRange**| | - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1LimitRange** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPersistentVolumeClaim** -> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaim(body) - -replace the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolumeClaim**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPersistentVolumeClaimStatus** -> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaimStatus(body) - -replace status of the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPersistentVolumeClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolumeClaim**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolumeClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPod** -> V1Pod replaceNamespacedPod(body) - -replace the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedPodRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPodEphemeralcontainers** -> V1Pod replaceNamespacedPodEphemeralcontainers(body) - -replace ephemeralcontainers of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodEphemeralcontainers(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPodResize** -> V1Pod replaceNamespacedPodResize(body) - -replace resize of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedPodResizeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodResizeRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodResize(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPodStatus** -> V1Pod replaceNamespacedPodStatus(body) - -replace status of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedPodStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodStatusRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Pod** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPodTemplate** -> V1PodTemplate replaceNamespacedPodTemplate(body) - -replace the specified PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedPodTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodTemplate**| | - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PodTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedReplicationController** -> V1ReplicationController replaceNamespacedReplicationController(body) - -replace the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedReplicationControllerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - "key": "key_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicationController**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ReplicationController** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedReplicationControllerScale** -> V1Scale replaceNamespacedReplicationControllerScale(body) - -replace scale of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicationControllerScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Scale** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedReplicationControllerStatus** -> V1ReplicationController replaceNamespacedReplicationControllerStatus(body) - -replace status of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - "key": "key_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicationControllerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicationController**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ReplicationController** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceQuota** -> V1ResourceQuota replaceNamespacedResourceQuota(body) - -replace the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedResourceQuotaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - hard: { - "key": "key_example", - }, - scopeSelector: { - matchExpressions: [ - { - operator: "operator_example", - scopeName: "scopeName_example", - values: [ - "values_example", - ], - }, - ], - }, - scopes: [ - "scopes_example", - ], - }, - status: { - hard: { - "key": "key_example", - }, - used: { - "key": "key_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceQuota**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ResourceQuota** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceQuotaStatus** -> V1ResourceQuota replaceNamespacedResourceQuotaStatus(body) - -replace status of the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - hard: { - "key": "key_example", - }, - scopeSelector: { - matchExpressions: [ - { - operator: "operator_example", - scopeName: "scopeName_example", - values: [ - "values_example", - ], - }, - ], - }, - scopes: [ - "scopes_example", - ], - }, - status: { - hard: { - "key": "key_example", - }, - used: { - "key": "key_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceQuotaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceQuota**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ResourceQuota** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedSecret** -> V1Secret replaceNamespacedSecret(body) - -replace the specified Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedSecretRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: { - "key": 'YQ==', - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - stringData: { - "key": "key_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Secret**| | - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Secret** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedService** -> V1Service replaceNamespacedService(body) - -replace the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedServiceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocateLoadBalancerNodePorts: true, - clusterIP: "clusterIP_example", - clusterIPs: [ - "clusterIPs_example", - ], - externalIPs: [ - "externalIPs_example", - ], - externalName: "externalName_example", - externalTrafficPolicy: "externalTrafficPolicy_example", - healthCheckNodePort: 1, - internalTrafficPolicy: "internalTrafficPolicy_example", - ipFamilies: [ - "ipFamilies_example", - ], - ipFamilyPolicy: "ipFamilyPolicy_example", - loadBalancerClass: "loadBalancerClass_example", - loadBalancerIP: "loadBalancerIP_example", - loadBalancerSourceRanges: [ - "loadBalancerSourceRanges_example", - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - nodePort: 1, - port: 1, - protocol: "protocol_example", - targetPort: "targetPort_example", - }, - ], - publishNotReadyAddresses: true, - selector: { - "key": "key_example", - }, - sessionAffinity: "sessionAffinity_example", - sessionAffinityConfig: { - clientIP: { - timeoutSeconds: 1, - }, - }, - trafficDistribution: "trafficDistribution_example", - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ipMode: "ipMode_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Service**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Service** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedServiceAccount** -> V1ServiceAccount replaceNamespacedServiceAccount(body) - -replace the specified ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedServiceAccountRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - automountServiceAccountToken: true, - imagePullSecrets: [ - { - name: "name_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - secrets: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceAccount**| | - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ServiceAccount** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedServiceStatus** -> V1Service replaceNamespacedServiceStatus(body) - -replace status of the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNamespacedServiceStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedServiceStatusRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocateLoadBalancerNodePorts: true, - clusterIP: "clusterIP_example", - clusterIPs: [ - "clusterIPs_example", - ], - externalIPs: [ - "externalIPs_example", - ], - externalName: "externalName_example", - externalTrafficPolicy: "externalTrafficPolicy_example", - healthCheckNodePort: 1, - internalTrafficPolicy: "internalTrafficPolicy_example", - ipFamilies: [ - "ipFamilies_example", - ], - ipFamilyPolicy: "ipFamilyPolicy_example", - loadBalancerClass: "loadBalancerClass_example", - loadBalancerIP: "loadBalancerIP_example", - loadBalancerSourceRanges: [ - "loadBalancerSourceRanges_example", - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - nodePort: 1, - port: 1, - protocol: "protocol_example", - targetPort: "targetPort_example", - }, - ], - publishNotReadyAddresses: true, - selector: { - "key": "key_example", - }, - sessionAffinity: "sessionAffinity_example", - sessionAffinityConfig: { - clientIP: { - timeoutSeconds: 1, - }, - }, - trafficDistribution: "trafficDistribution_example", - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ipMode: "ipMode_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Service**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Service** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNode** -> V1Node replaceNode(body) - -replace the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNodeRequest = { - // name of the Node - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - configSource: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - externalID: "externalID_example", - podCIDR: "podCIDR_example", - podCIDRs: [ - "podCIDRs_example", - ], - providerID: "providerID_example", - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - unschedulable: true, - }, - status: { - addresses: [ - { - address: "address_example", - type: "type_example", - }, - ], - allocatable: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - config: { - active: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - assigned: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - error: "error_example", - lastKnownGood: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - }, - daemonEndpoints: { - kubeletEndpoint: { - Port: 1, - }, - }, - declaredFeatures: [ - "declaredFeatures_example", - ], - features: { - supplementalGroupsPolicy: true, - }, - images: [ - { - names: [ - "names_example", - ], - sizeBytes: 1, - }, - ], - nodeInfo: { - architecture: "architecture_example", - bootID: "bootID_example", - containerRuntimeVersion: "containerRuntimeVersion_example", - kernelVersion: "kernelVersion_example", - kubeProxyVersion: "kubeProxyVersion_example", - kubeletVersion: "kubeletVersion_example", - machineID: "machineID_example", - operatingSystem: "operatingSystem_example", - osImage: "osImage_example", - swap: { - capacity: 1, - }, - systemUUID: "systemUUID_example", - }, - phase: "phase_example", - runtimeHandlers: [ - { - features: { - recursiveReadOnlyMounts: true, - userNamespaces: true, - }, - name: "name_example", - }, - ], - volumesAttached: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumesInUse: [ - "volumesInUse_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Node**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Node** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNodeStatus** -> V1Node replaceNodeStatus(body) - -replace status of the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplaceNodeStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNodeStatusRequest = { - // name of the Node - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - configSource: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - externalID: "externalID_example", - podCIDR: "podCIDR_example", - podCIDRs: [ - "podCIDRs_example", - ], - providerID: "providerID_example", - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - unschedulable: true, - }, - status: { - addresses: [ - { - address: "address_example", - type: "type_example", - }, - ], - allocatable: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - config: { - active: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - assigned: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - error: "error_example", - lastKnownGood: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - }, - daemonEndpoints: { - kubeletEndpoint: { - Port: 1, - }, - }, - declaredFeatures: [ - "declaredFeatures_example", - ], - features: { - supplementalGroupsPolicy: true, - }, - images: [ - { - names: [ - "names_example", - ], - sizeBytes: 1, - }, - ], - nodeInfo: { - architecture: "architecture_example", - bootID: "bootID_example", - containerRuntimeVersion: "containerRuntimeVersion_example", - kernelVersion: "kernelVersion_example", - kubeProxyVersion: "kubeProxyVersion_example", - kubeletVersion: "kubeletVersion_example", - machineID: "machineID_example", - operatingSystem: "operatingSystem_example", - osImage: "osImage_example", - swap: { - capacity: 1, - }, - systemUUID: "systemUUID_example", - }, - phase: "phase_example", - runtimeHandlers: [ - { - features: { - recursiveReadOnlyMounts: true, - userNamespaces: true, - }, - name: "name_example", - }, - ], - volumesAttached: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumesInUse: [ - "volumesInUse_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNodeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Node**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Node** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replacePersistentVolume** -> V1PersistentVolume replacePersistentVolume(body) - -replace the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplacePersistentVolumeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplacePersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - status: { - lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - phase: "phase_example", - reason: "reason_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolume**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolume** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replacePersistentVolumeStatus** -> V1PersistentVolume replacePersistentVolumeStatus(body) - -replace status of the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from ''; -import type { CoreV1ApiReplacePersistentVolumeStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplacePersistentVolumeStatusRequest = { - // name of the PersistentVolume - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - status: { - lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - phase: "phase_example", - reason: "reason_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePersistentVolumeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolume**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PersistentVolume** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/CustomObjectsApi.md b/src/gen/CustomObjectsApi.md deleted file mode 100644 index 02f7241d62..0000000000 --- a/src/gen/CustomObjectsApi.md +++ /dev/null @@ -1,2230 +0,0 @@ -# .CustomObjectsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterCustomObject**](CustomObjectsApi.md#createClusterCustomObject) | **POST** /apis/{group}/{version}/{plural} | -[**createNamespacedCustomObject**](CustomObjectsApi.md#createNamespacedCustomObject) | **POST** /apis/{group}/{version}/namespaces/{namespace}/{plural} | -[**deleteClusterCustomObject**](CustomObjectsApi.md#deleteClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural}/{name} | -[**deleteCollectionClusterCustomObject**](CustomObjectsApi.md#deleteCollectionClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural} | -[**deleteCollectionNamespacedCustomObject**](CustomObjectsApi.md#deleteCollectionNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural} | -[**deleteNamespacedCustomObject**](CustomObjectsApi.md#deleteNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**getAPIResources**](CustomObjectsApi.md#getAPIResources) | **GET** /apis/{group}/{version} | -[**getClusterCustomObject**](CustomObjectsApi.md#getClusterCustomObject) | **GET** /apis/{group}/{version}/{plural}/{name} | -[**getClusterCustomObjectScale**](CustomObjectsApi.md#getClusterCustomObjectScale) | **GET** /apis/{group}/{version}/{plural}/{name}/scale | -[**getClusterCustomObjectStatus**](CustomObjectsApi.md#getClusterCustomObjectStatus) | **GET** /apis/{group}/{version}/{plural}/{name}/status | -[**getNamespacedCustomObject**](CustomObjectsApi.md#getNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**getNamespacedCustomObjectScale**](CustomObjectsApi.md#getNamespacedCustomObjectScale) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | -[**getNamespacedCustomObjectStatus**](CustomObjectsApi.md#getNamespacedCustomObjectStatus) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | -[**listClusterCustomObject**](CustomObjectsApi.md#listClusterCustomObject) | **GET** /apis/{group}/{version}/{plural} | -[**listCustomObjectForAllNamespaces**](CustomObjectsApi.md#listCustomObjectForAllNamespaces) | **GET** /apis/{group}/{version}/{resource_plural} | -[**listNamespacedCustomObject**](CustomObjectsApi.md#listNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural} | -[**patchClusterCustomObject**](CustomObjectsApi.md#patchClusterCustomObject) | **PATCH** /apis/{group}/{version}/{plural}/{name} | -[**patchClusterCustomObjectScale**](CustomObjectsApi.md#patchClusterCustomObjectScale) | **PATCH** /apis/{group}/{version}/{plural}/{name}/scale | -[**patchClusterCustomObjectStatus**](CustomObjectsApi.md#patchClusterCustomObjectStatus) | **PATCH** /apis/{group}/{version}/{plural}/{name}/status | -[**patchNamespacedCustomObject**](CustomObjectsApi.md#patchNamespacedCustomObject) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**patchNamespacedCustomObjectScale**](CustomObjectsApi.md#patchNamespacedCustomObjectScale) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | -[**patchNamespacedCustomObjectStatus**](CustomObjectsApi.md#patchNamespacedCustomObjectStatus) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | -[**replaceClusterCustomObject**](CustomObjectsApi.md#replaceClusterCustomObject) | **PUT** /apis/{group}/{version}/{plural}/{name} | -[**replaceClusterCustomObjectScale**](CustomObjectsApi.md#replaceClusterCustomObjectScale) | **PUT** /apis/{group}/{version}/{plural}/{name}/scale | -[**replaceClusterCustomObjectStatus**](CustomObjectsApi.md#replaceClusterCustomObjectStatus) | **PUT** /apis/{group}/{version}/{plural}/{name}/status | -[**replaceNamespacedCustomObject**](CustomObjectsApi.md#replaceNamespacedCustomObject) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**replaceNamespacedCustomObjectScale**](CustomObjectsApi.md#replaceNamespacedCustomObjectScale) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | -[**replaceNamespacedCustomObjectStatus**](CustomObjectsApi.md#replaceNamespacedCustomObjectStatus) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | - - -# **createClusterCustomObject** -> any createClusterCustomObject(body) - -Creates a cluster scoped Custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiCreateClusterCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiCreateClusterCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // The JSON schema of the Resource to create. - body: {}, - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to create. | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedCustomObject** -> any createNamespacedCustomObject(body) - -Creates a namespace scoped Custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiCreateNamespacedCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiCreateNamespacedCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // The JSON schema of the Resource to create. - body: {}, - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to create. | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteClusterCustomObject** -> any deleteClusterCustomObject() - -Deletes the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiDeleteClusterCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionClusterCustomObject** -> any deleteCollectionClusterCustomObject() - -Delete collection of cluster scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiDeleteCollectionClusterCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteCollectionClusterCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedCustomObject** -> any deleteCollectionNamespacedCustomObject() - -Delete collection of namespace scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedCustomObject** -> any deleteNamespacedCustomObject() - -Deletes the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiDeleteNamespacedCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiGetAPIResourcesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetAPIResourcesRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", -}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getClusterCustomObject** -> any getClusterCustomObject() - -Returns a cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiGetClusterCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A single Resource | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getClusterCustomObjectScale** -> any getClusterCustomObjectScale() - -read scale of the specified custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiGetClusterCustomObjectScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetClusterCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getClusterCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getClusterCustomObjectStatus** -> any getClusterCustomObjectStatus() - -read status of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiGetClusterCustomObjectStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetClusterCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getClusterCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getNamespacedCustomObject** -> any getNamespacedCustomObject() - -Returns a namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiGetNamespacedCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A single Resource | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getNamespacedCustomObjectScale** -> any getNamespacedCustomObjectScale() - -read scale of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiGetNamespacedCustomObjectScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetNamespacedCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getNamespacedCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getNamespacedCustomObjectStatus** -> any getNamespacedCustomObjectStatus() - -read status of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiGetNamespacedCustomObjectStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetNamespacedCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getNamespacedCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listClusterCustomObject** -> any listClusterCustomObject() - -list or watch cluster scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiListClusterCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiListClusterCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/json;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listCustomObjectForAllNamespaces** -> any listCustomObjectForAllNamespaces() - -list or watch namespace scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiListCustomObjectForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiListCustomObjectForAllNamespacesRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - resourcePlural: "resource_plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) - watch: true, -}; - -const data = await apiInstance.listCustomObjectForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **resourcePlural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/json;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedCustomObject** -> any listNamespacedCustomObject() - -list or watch namespace scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiListNamespacedCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiListNamespacedCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/json;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchClusterCustomObject** -> any patchClusterCustomObject(body) - -patch the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiPatchClusterCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to patch. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to patch. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchClusterCustomObjectScale** -> any patchClusterCustomObjectScale(body) - -partially update scale of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiPatchClusterCustomObjectScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchClusterCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchClusterCustomObjectStatus** -> any patchClusterCustomObjectStatus(body) - -partially update status of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiPatchClusterCustomObjectStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchClusterCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedCustomObject** -> any patchNamespacedCustomObject(body) - -patch the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiPatchNamespacedCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to patch. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to patch. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedCustomObjectScale** -> any patchNamespacedCustomObjectScale(body) - -partially update scale of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiPatchNamespacedCustomObjectScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchNamespacedCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedCustomObjectStatus** -> any patchNamespacedCustomObjectStatus(body) - -partially update status of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiPatchNamespacedCustomObjectStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchNamespacedCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceClusterCustomObject** -> any replaceClusterCustomObject(body) - -replace the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiReplaceClusterCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to replace. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to replace. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceClusterCustomObjectScale** -> any replaceClusterCustomObjectScale(body) - -replace scale of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiReplaceClusterCustomObjectScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceClusterCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceClusterCustomObjectStatus** -> any replaceClusterCustomObjectStatus(body) - -replace status of the cluster scoped specified custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiReplaceClusterCustomObjectStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceClusterCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedCustomObject** -> any replaceNamespacedCustomObject(body) - -replace the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiReplaceNamespacedCustomObjectRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to replace. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to replace. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedCustomObjectScale** -> any replaceNamespacedCustomObjectScale(body) - -replace scale of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedCustomObjectStatus** -> any replaceNamespacedCustomObjectStatus(body) - -replace status of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from ''; -import type { CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - - -### Return type - -**any** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/DiscoveryApi.md b/src/gen/DiscoveryApi.md deleted file mode 100644 index 5f428cbcdd..0000000000 --- a/src/gen/DiscoveryApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .DiscoveryApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](DiscoveryApi.md#getAPIGroup) | **GET** /apis/discovery.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, DiscoveryApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/DiscoveryV1Api.md b/src/gen/DiscoveryV1Api.md deleted file mode 100644 index 430db4b9f8..0000000000 --- a/src/gen/DiscoveryV1Api.md +++ /dev/null @@ -1,908 +0,0 @@ -# .DiscoveryV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedEndpointSlice**](DiscoveryV1Api.md#createNamespacedEndpointSlice) | **POST** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | -[**deleteCollectionNamespacedEndpointSlice**](DiscoveryV1Api.md#deleteCollectionNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | -[**deleteNamespacedEndpointSlice**](DiscoveryV1Api.md#deleteNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | -[**getAPIResources**](DiscoveryV1Api.md#getAPIResources) | **GET** /apis/discovery.k8s.io/v1/ | -[**listEndpointSliceForAllNamespaces**](DiscoveryV1Api.md#listEndpointSliceForAllNamespaces) | **GET** /apis/discovery.k8s.io/v1/endpointslices | -[**listNamespacedEndpointSlice**](DiscoveryV1Api.md#listNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | -[**patchNamespacedEndpointSlice**](DiscoveryV1Api.md#patchNamespacedEndpointSlice) | **PATCH** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | -[**readNamespacedEndpointSlice**](DiscoveryV1Api.md#readNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | -[**replaceNamespacedEndpointSlice**](DiscoveryV1Api.md#replaceNamespacedEndpointSlice) | **PUT** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | - - -# **createNamespacedEndpointSlice** -> V1EndpointSlice createNamespacedEndpointSlice(body) - -create an EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from ''; -import type { DiscoveryV1ApiCreateNamespacedEndpointSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiCreateNamespacedEndpointSliceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - addressType: "addressType_example", - apiVersion: "apiVersion_example", - endpoints: [ - { - addresses: [ - "addresses_example", - ], - conditions: { - ready: true, - serving: true, - terminating: true, - }, - deprecatedTopology: { - "key": "key_example", - }, - hints: { - forNodes: [ - { - name: "name_example", - }, - ], - forZones: [ - { - name: "name_example", - }, - ], - }, - hostname: "hostname_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - zone: "zone_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1EndpointSlice**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1EndpointSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedEndpointSlice** -> V1Status deleteCollectionNamespacedEndpointSlice() - -delete collection of EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from ''; -import type { DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedEndpointSlice** -> V1Status deleteNamespacedEndpointSlice() - -delete an EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from ''; -import type { DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listEndpointSliceForAllNamespaces** -> V1EndpointSliceList listEndpointSliceForAllNamespaces() - -list or watch objects of kind EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from ''; -import type { DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEndpointSliceForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1EndpointSliceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedEndpointSlice** -> V1EndpointSliceList listNamespacedEndpointSlice() - -list or watch objects of kind EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from ''; -import type { DiscoveryV1ApiListNamespacedEndpointSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiListNamespacedEndpointSliceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1EndpointSliceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedEndpointSlice** -> V1EndpointSlice patchNamespacedEndpointSlice(body) - -partially update the specified EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from ''; -import type { DiscoveryV1ApiPatchNamespacedEndpointSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiPatchNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1EndpointSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedEndpointSlice** -> V1EndpointSlice readNamespacedEndpointSlice() - -read the specified EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from ''; -import type { DiscoveryV1ApiReadNamespacedEndpointSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiReadNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1EndpointSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedEndpointSlice** -> V1EndpointSlice replaceNamespacedEndpointSlice(body) - -replace the specified EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from ''; -import type { DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - addressType: "addressType_example", - apiVersion: "apiVersion_example", - endpoints: [ - { - addresses: [ - "addresses_example", - ], - conditions: { - ready: true, - serving: true, - terminating: true, - }, - deprecatedTopology: { - "key": "key_example", - }, - hints: { - forNodes: [ - { - name: "name_example", - }, - ], - forZones: [ - { - name: "name_example", - }, - ], - }, - hostname: "hostname_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - zone: "zone_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1EndpointSlice**| | - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1EndpointSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/EventsApi.md b/src/gen/EventsApi.md deleted file mode 100644 index c9a897d0f1..0000000000 --- a/src/gen/EventsApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .EventsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](EventsApi.md#getAPIGroup) | **GET** /apis/events.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, EventsApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new EventsApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/EventsV1Api.md b/src/gen/EventsV1Api.md deleted file mode 100644 index a8a7c24508..0000000000 --- a/src/gen/EventsV1Api.md +++ /dev/null @@ -1,884 +0,0 @@ -# .EventsV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedEvent**](EventsV1Api.md#createNamespacedEvent) | **POST** /apis/events.k8s.io/v1/namespaces/{namespace}/events | -[**deleteCollectionNamespacedEvent**](EventsV1Api.md#deleteCollectionNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events | -[**deleteNamespacedEvent**](EventsV1Api.md#deleteNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | -[**getAPIResources**](EventsV1Api.md#getAPIResources) | **GET** /apis/events.k8s.io/v1/ | -[**listEventForAllNamespaces**](EventsV1Api.md#listEventForAllNamespaces) | **GET** /apis/events.k8s.io/v1/events | -[**listNamespacedEvent**](EventsV1Api.md#listNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events | -[**patchNamespacedEvent**](EventsV1Api.md#patchNamespacedEvent) | **PATCH** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | -[**readNamespacedEvent**](EventsV1Api.md#readNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | -[**replaceNamespacedEvent**](EventsV1Api.md#replaceNamespacedEvent) | **PUT** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | - - -# **createNamespacedEvent** -> EventsV1Event createNamespacedEvent(body) - -create an Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from ''; -import type { EventsV1ApiCreateNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiCreateNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - deprecatedCount: 1, - deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedSource: { - component: "component_example", - host: "host_example", - }, - eventTime: "eventTime_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - note: "note_example", - reason: "reason_example", - regarding: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingController: "reportingController_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **EventsV1Event**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**EventsV1Event** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedEvent** -> V1Status deleteCollectionNamespacedEvent() - -delete collection of Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from ''; -import type { EventsV1ApiDeleteCollectionNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiDeleteCollectionNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedEvent** -> V1Status deleteNamespacedEvent() - -delete an Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from ''; -import type { EventsV1ApiDeleteNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiDeleteNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listEventForAllNamespaces** -> EventsV1EventList listEventForAllNamespaces() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from ''; -import type { EventsV1ApiListEventForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiListEventForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEventForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**EventsV1EventList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedEvent** -> EventsV1EventList listNamespacedEvent() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from ''; -import type { EventsV1ApiListNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiListNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**EventsV1EventList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedEvent** -> EventsV1Event patchNamespacedEvent(body) - -partially update the specified Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from ''; -import type { EventsV1ApiPatchNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiPatchNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**EventsV1Event** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedEvent** -> EventsV1Event readNamespacedEvent() - -read the specified Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from ''; -import type { EventsV1ApiReadNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiReadNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**EventsV1Event** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedEvent** -> EventsV1Event replaceNamespacedEvent(body) - -replace the specified Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from ''; -import type { EventsV1ApiReplaceNamespacedEventRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiReplaceNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - deprecatedCount: 1, - deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedSource: { - component: "component_example", - host: "host_example", - }, - eventTime: "eventTime_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - note: "note_example", - reason: "reason_example", - regarding: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingController: "reportingController_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **EventsV1Event**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**EventsV1Event** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/FlowcontrolApiserverApi.md b/src/gen/FlowcontrolApiserverApi.md deleted file mode 100644 index c08c9b10a5..0000000000 --- a/src/gen/FlowcontrolApiserverApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .FlowcontrolApiserverApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](FlowcontrolApiserverApi.md#getAPIGroup) | **GET** /apis/flowcontrol.apiserver.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/FlowcontrolApiserverV1Api.md b/src/gen/FlowcontrolApiserverV1Api.md deleted file mode 100644 index 4c71ac4ab5..0000000000 --- a/src/gen/FlowcontrolApiserverV1Api.md +++ /dev/null @@ -1,2142 +0,0 @@ -# .FlowcontrolApiserverV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createFlowSchema**](FlowcontrolApiserverV1Api.md#createFlowSchema) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | -[**createPriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#createPriorityLevelConfiguration) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | -[**deleteCollectionFlowSchema**](FlowcontrolApiserverV1Api.md#deleteCollectionFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | -[**deleteCollectionPriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#deleteCollectionPriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | -[**deleteFlowSchema**](FlowcontrolApiserverV1Api.md#deleteFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**deletePriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#deletePriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**getAPIResources**](FlowcontrolApiserverV1Api.md#getAPIResources) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/ | -[**listFlowSchema**](FlowcontrolApiserverV1Api.md#listFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | -[**listPriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#listPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | -[**patchFlowSchema**](FlowcontrolApiserverV1Api.md#patchFlowSchema) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**patchFlowSchemaStatus**](FlowcontrolApiserverV1Api.md#patchFlowSchemaStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | -[**patchPriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#patchPriorityLevelConfiguration) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**patchPriorityLevelConfigurationStatus**](FlowcontrolApiserverV1Api.md#patchPriorityLevelConfigurationStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | -[**readFlowSchema**](FlowcontrolApiserverV1Api.md#readFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**readFlowSchemaStatus**](FlowcontrolApiserverV1Api.md#readFlowSchemaStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | -[**readPriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#readPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**readPriorityLevelConfigurationStatus**](FlowcontrolApiserverV1Api.md#readPriorityLevelConfigurationStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | -[**replaceFlowSchema**](FlowcontrolApiserverV1Api.md#replaceFlowSchema) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**replaceFlowSchemaStatus**](FlowcontrolApiserverV1Api.md#replaceFlowSchemaStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | -[**replacePriorityLevelConfiguration**](FlowcontrolApiserverV1Api.md#replacePriorityLevelConfiguration) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**replacePriorityLevelConfigurationStatus**](FlowcontrolApiserverV1Api.md#replacePriorityLevelConfigurationStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | - - -# **createFlowSchema** -> V1FlowSchema createFlowSchema(body) - -create a FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiCreateFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiCreateFlowSchemaRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1FlowSchema**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createPriorityLevelConfiguration** -> V1PriorityLevelConfiguration createPriorityLevelConfiguration(body) - -create a PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityLevelConfiguration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionFlowSchema** -> V1Status deleteCollectionFlowSchema() - -delete collection of FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionPriorityLevelConfiguration** -> V1Status deleteCollectionPriorityLevelConfiguration() - -delete collection of PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteFlowSchema** -> V1Status deleteFlowSchema() - -delete a FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deletePriorityLevelConfiguration** -> V1Status deletePriorityLevelConfiguration() - -delete a PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deletePriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listFlowSchema** -> V1FlowSchemaList listFlowSchema() - -list or watch objects of kind FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiListFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiListFlowSchemaRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1FlowSchemaList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listPriorityLevelConfiguration** -> V1PriorityLevelConfigurationList listPriorityLevelConfiguration() - -list or watch objects of kind PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PriorityLevelConfigurationList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchFlowSchema** -> V1FlowSchema patchFlowSchema(body) - -partially update the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiPatchFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchFlowSchemaStatus** -> V1FlowSchema patchFlowSchemaStatus(body) - -partially update status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchPriorityLevelConfiguration** -> V1PriorityLevelConfiguration patchPriorityLevelConfiguration(body) - -partially update the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchPriorityLevelConfigurationStatus** -> V1PriorityLevelConfiguration patchPriorityLevelConfigurationStatus(body) - -partially update status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readFlowSchema** -> V1FlowSchema readFlowSchema() - -read the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiReadFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readFlowSchemaStatus** -> V1FlowSchema readFlowSchemaStatus() - -read status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readPriorityLevelConfiguration** -> V1PriorityLevelConfiguration readPriorityLevelConfiguration() - -read the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readPriorityLevelConfigurationStatus** -> V1PriorityLevelConfiguration readPriorityLevelConfigurationStatus() - -read status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceFlowSchema** -> V1FlowSchema replaceFlowSchema(body) - -replace the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1FlowSchema**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceFlowSchemaStatus** -> V1FlowSchema replaceFlowSchemaStatus(body) - -replace status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1FlowSchema**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replacePriorityLevelConfiguration** -> V1PriorityLevelConfiguration replacePriorityLevelConfiguration(body) - -replace the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityLevelConfiguration**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replacePriorityLevelConfigurationStatus** -> V1PriorityLevelConfiguration replacePriorityLevelConfigurationStatus(body) - -replace status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from ''; -import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityLevelConfiguration**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/FlowcontrolApiserverV1beta3Api.md b/src/gen/FlowcontrolApiserverV1beta3Api.md deleted file mode 100644 index 62e7a7135e..0000000000 --- a/src/gen/FlowcontrolApiserverV1beta3Api.md +++ /dev/null @@ -1,2126 +0,0 @@ -# .FlowcontrolApiserverV1beta3Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createFlowSchema**](FlowcontrolApiserverV1beta3Api.md#createFlowSchema) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas | -[**createPriorityLevelConfiguration**](FlowcontrolApiserverV1beta3Api.md#createPriorityLevelConfiguration) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations | -[**deleteCollectionFlowSchema**](FlowcontrolApiserverV1beta3Api.md#deleteCollectionFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas | -[**deleteCollectionPriorityLevelConfiguration**](FlowcontrolApiserverV1beta3Api.md#deleteCollectionPriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations | -[**deleteFlowSchema**](FlowcontrolApiserverV1beta3Api.md#deleteFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name} | -[**deletePriorityLevelConfiguration**](FlowcontrolApiserverV1beta3Api.md#deletePriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name} | -[**getAPIResources**](FlowcontrolApiserverV1beta3Api.md#getAPIResources) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1beta3/ | -[**listFlowSchema**](FlowcontrolApiserverV1beta3Api.md#listFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas | -[**listPriorityLevelConfiguration**](FlowcontrolApiserverV1beta3Api.md#listPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations | -[**patchFlowSchema**](FlowcontrolApiserverV1beta3Api.md#patchFlowSchema) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name} | -[**patchFlowSchemaStatus**](FlowcontrolApiserverV1beta3Api.md#patchFlowSchemaStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name}/status | -[**patchPriorityLevelConfiguration**](FlowcontrolApiserverV1beta3Api.md#patchPriorityLevelConfiguration) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name} | -[**patchPriorityLevelConfigurationStatus**](FlowcontrolApiserverV1beta3Api.md#patchPriorityLevelConfigurationStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}/status | -[**readFlowSchema**](FlowcontrolApiserverV1beta3Api.md#readFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name} | -[**readFlowSchemaStatus**](FlowcontrolApiserverV1beta3Api.md#readFlowSchemaStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name}/status | -[**readPriorityLevelConfiguration**](FlowcontrolApiserverV1beta3Api.md#readPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name} | -[**readPriorityLevelConfigurationStatus**](FlowcontrolApiserverV1beta3Api.md#readPriorityLevelConfigurationStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}/status | -[**replaceFlowSchema**](FlowcontrolApiserverV1beta3Api.md#replaceFlowSchema) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name} | -[**replaceFlowSchemaStatus**](FlowcontrolApiserverV1beta3Api.md#replaceFlowSchemaStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name}/status | -[**replacePriorityLevelConfiguration**](FlowcontrolApiserverV1beta3Api.md#replacePriorityLevelConfiguration) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name} | -[**replacePriorityLevelConfigurationStatus**](FlowcontrolApiserverV1beta3Api.md#replacePriorityLevelConfigurationStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}/status | - - -# **createFlowSchema** -> V1beta3FlowSchema createFlowSchema(body) - -create a FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiCreateFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiCreateFlowSchemaRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta3FlowSchema**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta3FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createPriorityLevelConfiguration** -> V1beta3PriorityLevelConfiguration createPriorityLevelConfiguration(body) - -create a PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiCreatePriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiCreatePriorityLevelConfigurationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta3PriorityLevelConfiguration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta3PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionFlowSchema** -> V1Status deleteCollectionFlowSchema() - -delete collection of FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiDeleteCollectionFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiDeleteCollectionFlowSchemaRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionPriorityLevelConfiguration** -> V1Status deleteCollectionPriorityLevelConfiguration() - -delete collection of PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiDeleteCollectionPriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiDeleteCollectionPriorityLevelConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteFlowSchema** -> V1Status deleteFlowSchema() - -delete a FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiDeleteFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiDeleteFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deletePriorityLevelConfiguration** -> V1Status deletePriorityLevelConfiguration() - -delete a PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiDeletePriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiDeletePriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deletePriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listFlowSchema** -> V1beta3FlowSchemaList listFlowSchema() - -list or watch objects of kind FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiListFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiListFlowSchemaRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta3FlowSchemaList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listPriorityLevelConfiguration** -> V1beta3PriorityLevelConfigurationList listPriorityLevelConfiguration() - -list or watch objects of kind PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiListPriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiListPriorityLevelConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta3PriorityLevelConfigurationList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchFlowSchema** -> V1beta3FlowSchema patchFlowSchema(body) - -partially update the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiPatchFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiPatchFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta3FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchFlowSchemaStatus** -> V1beta3FlowSchema patchFlowSchemaStatus(body) - -partially update status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiPatchFlowSchemaStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiPatchFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta3FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchPriorityLevelConfiguration** -> V1beta3PriorityLevelConfiguration patchPriorityLevelConfiguration(body) - -partially update the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiPatchPriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiPatchPriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta3PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchPriorityLevelConfigurationStatus** -> V1beta3PriorityLevelConfiguration patchPriorityLevelConfigurationStatus(body) - -partially update status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiPatchPriorityLevelConfigurationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiPatchPriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta3PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readFlowSchema** -> V1beta3FlowSchema readFlowSchema() - -read the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiReadFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiReadFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta3FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readFlowSchemaStatus** -> V1beta3FlowSchema readFlowSchemaStatus() - -read status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiReadFlowSchemaStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiReadFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta3FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readPriorityLevelConfiguration** -> V1beta3PriorityLevelConfiguration readPriorityLevelConfiguration() - -read the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiReadPriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiReadPriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta3PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readPriorityLevelConfigurationStatus** -> V1beta3PriorityLevelConfiguration readPriorityLevelConfigurationStatus() - -read status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiReadPriorityLevelConfigurationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiReadPriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta3PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceFlowSchema** -> V1beta3FlowSchema replaceFlowSchema(body) - -replace the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiReplaceFlowSchemaRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiReplaceFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta3FlowSchema**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta3FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceFlowSchemaStatus** -> V1beta3FlowSchema replaceFlowSchemaStatus(body) - -replace status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiReplaceFlowSchemaStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiReplaceFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta3FlowSchema**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta3FlowSchema** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replacePriorityLevelConfiguration** -> V1beta3PriorityLevelConfiguration replacePriorityLevelConfiguration(body) - -replace the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiReplacePriorityLevelConfigurationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiReplacePriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta3PriorityLevelConfiguration**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta3PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replacePriorityLevelConfigurationStatus** -> V1beta3PriorityLevelConfiguration replacePriorityLevelConfigurationStatus(body) - -replace status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1beta3Api } from ''; -import type { FlowcontrolApiserverV1beta3ApiReplacePriorityLevelConfigurationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1beta3Api(configuration); - -const request: FlowcontrolApiserverV1beta3ApiReplacePriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta3PriorityLevelConfiguration**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta3PriorityLevelConfiguration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/InternalApiserverApi.md b/src/gen/InternalApiserverApi.md deleted file mode 100644 index def720c026..0000000000 --- a/src/gen/InternalApiserverApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .InternalApiserverApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](InternalApiserverApi.md#getAPIGroup) | **GET** /apis/internal.apiserver.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, InternalApiserverApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/InternalApiserverV1alpha1Api.md b/src/gen/InternalApiserverV1alpha1Api.md deleted file mode 100644 index 0f20d915c2..0000000000 --- a/src/gen/InternalApiserverV1alpha1Api.md +++ /dev/null @@ -1,1032 +0,0 @@ -# .InternalApiserverV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createStorageVersion**](InternalApiserverV1alpha1Api.md#createStorageVersion) | **POST** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | -[**deleteCollectionStorageVersion**](InternalApiserverV1alpha1Api.md#deleteCollectionStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | -[**deleteStorageVersion**](InternalApiserverV1alpha1Api.md#deleteStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**getAPIResources**](InternalApiserverV1alpha1Api.md#getAPIResources) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/ | -[**listStorageVersion**](InternalApiserverV1alpha1Api.md#listStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | -[**patchStorageVersion**](InternalApiserverV1alpha1Api.md#patchStorageVersion) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**patchStorageVersionStatus**](InternalApiserverV1alpha1Api.md#patchStorageVersionStatus) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | -[**readStorageVersion**](InternalApiserverV1alpha1Api.md#readStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**readStorageVersionStatus**](InternalApiserverV1alpha1Api.md#readStorageVersionStatus) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | -[**replaceStorageVersion**](InternalApiserverV1alpha1Api.md#replaceStorageVersion) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**replaceStorageVersionStatus**](InternalApiserverV1alpha1Api.md#replaceStorageVersionStatus) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | - - -# **createStorageVersion** -> V1alpha1StorageVersion createStorageVersion(body) - -create a StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; -import type { InternalApiserverV1alpha1ApiCreateStorageVersionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiCreateStorageVersionRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: {}, - status: { - commonEncodingVersion: "commonEncodingVersion_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - storageVersions: [ - { - apiServerID: "apiServerID_example", - decodableVersions: [ - "decodableVersions_example", - ], - encodingVersion: "encodingVersion_example", - servedVersions: [ - "servedVersions_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersion**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersion** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionStorageVersion** -> V1Status deleteCollectionStorageVersion() - -delete collection of StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; -import type { InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteStorageVersion** -> V1Status deleteStorageVersion() - -delete a StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; -import type { InternalApiserverV1alpha1ApiDeleteStorageVersionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiDeleteStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listStorageVersion** -> V1alpha1StorageVersionList listStorageVersion() - -list or watch objects of kind StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; -import type { InternalApiserverV1alpha1ApiListStorageVersionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiListStorageVersionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersionList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchStorageVersion** -> V1alpha1StorageVersion patchStorageVersion(body) - -partially update the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; -import type { InternalApiserverV1alpha1ApiPatchStorageVersionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiPatchStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersion** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchStorageVersionStatus** -> V1alpha1StorageVersion patchStorageVersionStatus(body) - -partially update status of the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; -import type { InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest = { - // name of the StorageVersion - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersion** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readStorageVersion** -> V1alpha1StorageVersion readStorageVersion() - -read the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; -import type { InternalApiserverV1alpha1ApiReadStorageVersionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReadStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersion** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readStorageVersionStatus** -> V1alpha1StorageVersion readStorageVersionStatus() - -read status of the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; -import type { InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest = { - // name of the StorageVersion - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersion** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceStorageVersion** -> V1alpha1StorageVersion replaceStorageVersion(body) - -replace the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; -import type { InternalApiserverV1alpha1ApiReplaceStorageVersionRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReplaceStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: {}, - status: { - commonEncodingVersion: "commonEncodingVersion_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - storageVersions: [ - { - apiServerID: "apiServerID_example", - decodableVersions: [ - "decodableVersions_example", - ], - encodingVersion: "encodingVersion_example", - servedVersions: [ - "servedVersions_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersion**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersion** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceStorageVersionStatus** -> V1alpha1StorageVersion replaceStorageVersionStatus(body) - -replace status of the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from ''; -import type { InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest = { - // name of the StorageVersion - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: {}, - status: { - commonEncodingVersion: "commonEncodingVersion_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - storageVersions: [ - { - apiServerID: "apiServerID_example", - decodableVersions: [ - "decodableVersions_example", - ], - encodingVersion: "encodingVersion_example", - servedVersions: [ - "servedVersions_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersion**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersion** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/LogsApi.md b/src/gen/LogsApi.md deleted file mode 100644 index 902d0f8c60..0000000000 --- a/src/gen/LogsApi.md +++ /dev/null @@ -1,108 +0,0 @@ -# .LogsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**logFileHandler**](LogsApi.md#logFileHandler) | **GET** /logs/{logpath} | -[**logFileListHandler**](LogsApi.md#logFileListHandler) | **GET** /logs/ | - - -# **logFileHandler** -> logFileHandler() - - -### Example - - -```typescript -import { createConfiguration, LogsApi } from ''; -import type { LogsApiLogFileHandlerRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new LogsApi(configuration); - -const request: LogsApiLogFileHandlerRequest = { - // path to the log - logpath: "logpath_example", -}; - -const data = await apiInstance.logFileHandler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **logpath** | [**string**] | path to the log | defaults to undefined - - -### Return type - -void (empty response body) - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **logFileListHandler** -> logFileListHandler() - - -### Example - - -```typescript -import { createConfiguration, LogsApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new LogsApi(configuration); - -const request = {}; - -const data = await apiInstance.logFileListHandler(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -void (empty response body) - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/NetworkingApi.md b/src/gen/NetworkingApi.md deleted file mode 100644 index b1832f1a30..0000000000 --- a/src/gen/NetworkingApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .NetworkingApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](NetworkingApi.md#getAPIGroup) | **GET** /apis/networking.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, NetworkingApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/NetworkingV1Api.md b/src/gen/NetworkingV1Api.md deleted file mode 100644 index abcdc5d918..0000000000 --- a/src/gen/NetworkingV1Api.md +++ /dev/null @@ -1,4547 +0,0 @@ -# .NetworkingV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createIPAddress**](NetworkingV1Api.md#createIPAddress) | **POST** /apis/networking.k8s.io/v1/ipaddresses | -[**createIngressClass**](NetworkingV1Api.md#createIngressClass) | **POST** /apis/networking.k8s.io/v1/ingressclasses | -[**createNamespacedIngress**](NetworkingV1Api.md#createNamespacedIngress) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | -[**createNamespacedNetworkPolicy**](NetworkingV1Api.md#createNamespacedNetworkPolicy) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | -[**createServiceCIDR**](NetworkingV1Api.md#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1/servicecidrs | -[**deleteCollectionIPAddress**](NetworkingV1Api.md#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses | -[**deleteCollectionIngressClass**](NetworkingV1Api.md#deleteCollectionIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses | -[**deleteCollectionNamespacedIngress**](NetworkingV1Api.md#deleteCollectionNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | -[**deleteCollectionNamespacedNetworkPolicy**](NetworkingV1Api.md#deleteCollectionNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | -[**deleteCollectionServiceCIDR**](NetworkingV1Api.md#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs | -[**deleteIPAddress**](NetworkingV1Api.md#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**deleteIngressClass**](NetworkingV1Api.md#deleteIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**deleteNamespacedIngress**](NetworkingV1Api.md#deleteNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**deleteNamespacedNetworkPolicy**](NetworkingV1Api.md#deleteNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**deleteServiceCIDR**](NetworkingV1Api.md#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**getAPIResources**](NetworkingV1Api.md#getAPIResources) | **GET** /apis/networking.k8s.io/v1/ | -[**listIPAddress**](NetworkingV1Api.md#listIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses | -[**listIngressClass**](NetworkingV1Api.md#listIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses | -[**listIngressForAllNamespaces**](NetworkingV1Api.md#listIngressForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/ingresses | -[**listNamespacedIngress**](NetworkingV1Api.md#listNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | -[**listNamespacedNetworkPolicy**](NetworkingV1Api.md#listNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | -[**listNetworkPolicyForAllNamespaces**](NetworkingV1Api.md#listNetworkPolicyForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/networkpolicies | -[**listServiceCIDR**](NetworkingV1Api.md#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs | -[**patchIPAddress**](NetworkingV1Api.md#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**patchIngressClass**](NetworkingV1Api.md#patchIngressClass) | **PATCH** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**patchNamespacedIngress**](NetworkingV1Api.md#patchNamespacedIngress) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**patchNamespacedIngressStatus**](NetworkingV1Api.md#patchNamespacedIngressStatus) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | -[**patchNamespacedNetworkPolicy**](NetworkingV1Api.md#patchNamespacedNetworkPolicy) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**patchServiceCIDR**](NetworkingV1Api.md#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**patchServiceCIDRStatus**](NetworkingV1Api.md#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | -[**readIPAddress**](NetworkingV1Api.md#readIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**readIngressClass**](NetworkingV1Api.md#readIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**readNamespacedIngress**](NetworkingV1Api.md#readNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**readNamespacedIngressStatus**](NetworkingV1Api.md#readNamespacedIngressStatus) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | -[**readNamespacedNetworkPolicy**](NetworkingV1Api.md#readNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**readServiceCIDR**](NetworkingV1Api.md#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**readServiceCIDRStatus**](NetworkingV1Api.md#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | -[**replaceIPAddress**](NetworkingV1Api.md#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**replaceIngressClass**](NetworkingV1Api.md#replaceIngressClass) | **PUT** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**replaceNamespacedIngress**](NetworkingV1Api.md#replaceNamespacedIngress) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**replaceNamespacedIngressStatus**](NetworkingV1Api.md#replaceNamespacedIngressStatus) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | -[**replaceNamespacedNetworkPolicy**](NetworkingV1Api.md#replaceNamespacedNetworkPolicy) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**replaceServiceCIDR**](NetworkingV1Api.md#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**replaceServiceCIDRStatus**](NetworkingV1Api.md#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | - - -# **createIPAddress** -> V1IPAddress createIPAddress(body) - -create an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiCreateIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateIPAddressRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IPAddress**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createIngressClass** -> V1IngressClass createIngressClass(body) - -create an IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiCreateIngressClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateIngressClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controller: "controller_example", - parameters: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - scope: "scope_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IngressClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1IngressClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedIngress** -> V1Ingress createNamespacedIngress(body) - -create an Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiCreateNamespacedIngressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateNamespacedIngressRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - defaultBackend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - ingressClassName: "ingressClassName_example", - rules: [ - { - host: "host_example", - http: { - paths: [ - { - backend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - path: "path_example", - pathType: "pathType_example", - }, - ], - }, - }, - ], - tls: [ - { - hosts: [ - "hosts_example", - ], - secretName: "secretName_example", - }, - ], - }, - status: { - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Ingress**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Ingress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedNetworkPolicy** -> V1NetworkPolicy createNamespacedNetworkPolicy(body) - -create a NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiCreateNamespacedNetworkPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateNamespacedNetworkPolicyRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - egress: [ - { - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - to: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - }, - ], - ingress: [ - { - _from: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - }, - ], - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - policyTypes: [ - "policyTypes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1NetworkPolicy**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1NetworkPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createServiceCIDR** -> V1ServiceCIDR createServiceCIDR(body) - -create a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiCreateServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateServiceCIDRRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceCIDR**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionIPAddress** -> V1Status deleteCollectionIPAddress() - -delete collection of IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiDeleteCollectionIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionIngressClass** -> V1Status deleteCollectionIngressClass() - -delete collection of IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiDeleteCollectionIngressClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionIngressClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedIngress** -> V1Status deleteCollectionNamespacedIngress() - -delete collection of Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiDeleteCollectionNamespacedIngressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionNamespacedIngressRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedNetworkPolicy** -> V1Status deleteCollectionNamespacedNetworkPolicy() - -delete collection of NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionServiceCIDR** -> V1Status deleteCollectionServiceCIDR() - -delete collection of ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiDeleteCollectionServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteIPAddress** -> V1Status deleteIPAddress() - -delete an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiDeleteIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteIngressClass** -> V1Status deleteIngressClass() - -delete an IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiDeleteIngressClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteIngressClassRequest = { - // name of the IngressClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedIngress** -> V1Status deleteNamespacedIngress() - -delete an Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiDeleteNamespacedIngressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedNetworkPolicy** -> V1Status deleteNamespacedNetworkPolicy() - -delete a NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteServiceCIDR** -> V1Status deleteServiceCIDR() - -delete a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiDeleteServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listIPAddress** -> V1IPAddressList listIPAddress() - -list or watch objects of kind IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiListIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1IPAddressList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listIngressClass** -> V1IngressClassList listIngressClass() - -list or watch objects of kind IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiListIngressClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListIngressClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1IngressClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listIngressForAllNamespaces** -> V1IngressList listIngressForAllNamespaces() - -list or watch objects of kind Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiListIngressForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListIngressForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIngressForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1IngressList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedIngress** -> V1IngressList listNamespacedIngress() - -list or watch objects of kind Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiListNamespacedIngressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListNamespacedIngressRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1IngressList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedNetworkPolicy** -> V1NetworkPolicyList listNamespacedNetworkPolicy() - -list or watch objects of kind NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiListNamespacedNetworkPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListNamespacedNetworkPolicyRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1NetworkPolicyList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNetworkPolicyForAllNamespaces** -> V1NetworkPolicyList listNetworkPolicyForAllNamespaces() - -list or watch objects of kind NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNetworkPolicyForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1NetworkPolicyList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listServiceCIDR** -> V1ServiceCIDRList listServiceCIDR() - -list or watch objects of kind ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiListServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ServiceCIDRList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchIPAddress** -> V1IPAddress patchIPAddress(body) - -partially update the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiPatchIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchIngressClass** -> V1IngressClass patchIngressClass(body) - -partially update the specified IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiPatchIngressClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchIngressClassRequest = { - // name of the IngressClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1IngressClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedIngress** -> V1Ingress patchNamespacedIngress(body) - -partially update the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiPatchNamespacedIngressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Ingress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedIngressStatus** -> V1Ingress patchNamespacedIngressStatus(body) - -partially update status of the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiPatchNamespacedIngressStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchNamespacedIngressStatusRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedIngressStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Ingress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedNetworkPolicy** -> V1NetworkPolicy patchNamespacedNetworkPolicy(body) - -partially update the specified NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiPatchNamespacedNetworkPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1NetworkPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchServiceCIDR** -> V1ServiceCIDR patchServiceCIDR(body) - -partially update the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiPatchServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchServiceCIDRStatus** -> V1ServiceCIDR patchServiceCIDRStatus(body) - -partially update status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiPatchServiceCIDRStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readIPAddress** -> V1IPAddress readIPAddress() - -read the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReadIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readIngressClass** -> V1IngressClass readIngressClass() - -read the specified IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReadIngressClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadIngressClassRequest = { - // name of the IngressClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1IngressClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedIngress** -> V1Ingress readNamespacedIngress() - -read the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReadNamespacedIngressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Ingress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedIngressStatus** -> V1Ingress readNamespacedIngressStatus() - -read status of the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReadNamespacedIngressStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadNamespacedIngressStatusRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedIngressStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Ingress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedNetworkPolicy** -> V1NetworkPolicy readNamespacedNetworkPolicy() - -read the specified NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReadNamespacedNetworkPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1NetworkPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readServiceCIDR** -> V1ServiceCIDR readServiceCIDR() - -read the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReadServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readServiceCIDRStatus** -> V1ServiceCIDR readServiceCIDRStatus() - -read status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReadServiceCIDRStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceIPAddress** -> V1IPAddress replaceIPAddress(body) - -replace the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReplaceIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IPAddress**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceIngressClass** -> V1IngressClass replaceIngressClass(body) - -replace the specified IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReplaceIngressClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceIngressClassRequest = { - // name of the IngressClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controller: "controller_example", - parameters: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - scope: "scope_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IngressClass**| | - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1IngressClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedIngress** -> V1Ingress replaceNamespacedIngress(body) - -replace the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReplaceNamespacedIngressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - defaultBackend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - ingressClassName: "ingressClassName_example", - rules: [ - { - host: "host_example", - http: { - paths: [ - { - backend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - path: "path_example", - pathType: "pathType_example", - }, - ], - }, - }, - ], - tls: [ - { - hosts: [ - "hosts_example", - ], - secretName: "secretName_example", - }, - ], - }, - status: { - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Ingress**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Ingress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedIngressStatus** -> V1Ingress replaceNamespacedIngressStatus(body) - -replace status of the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReplaceNamespacedIngressStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceNamespacedIngressStatusRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - defaultBackend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - ingressClassName: "ingressClassName_example", - rules: [ - { - host: "host_example", - http: { - paths: [ - { - backend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - path: "path_example", - pathType: "pathType_example", - }, - ], - }, - }, - ], - tls: [ - { - hosts: [ - "hosts_example", - ], - secretName: "secretName_example", - }, - ], - }, - status: { - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedIngressStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Ingress**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Ingress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedNetworkPolicy** -> V1NetworkPolicy replaceNamespacedNetworkPolicy(body) - -replace the specified NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - egress: [ - { - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - to: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - }, - ], - ingress: [ - { - _from: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - }, - ], - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - policyTypes: [ - "policyTypes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1NetworkPolicy**| | - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1NetworkPolicy** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceServiceCIDR** -> V1ServiceCIDR replaceServiceCIDR(body) - -replace the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReplaceServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceServiceCIDRStatus** -> V1ServiceCIDR replaceServiceCIDRStatus(body) - -replace status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from ''; -import type { NetworkingV1ApiReplaceServiceCIDRStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/NetworkingV1alpha1Api.md b/src/gen/NetworkingV1alpha1Api.md deleted file mode 100644 index 3ea9fa89af..0000000000 --- a/src/gen/NetworkingV1alpha1Api.md +++ /dev/null @@ -1,1654 +0,0 @@ -# .NetworkingV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createIPAddress**](NetworkingV1alpha1Api.md#createIPAddress) | **POST** /apis/networking.k8s.io/v1alpha1/ipaddresses | -[**createServiceCIDR**](NetworkingV1alpha1Api.md#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1alpha1/servicecidrs | -[**deleteCollectionIPAddress**](NetworkingV1alpha1Api.md#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1alpha1/ipaddresses | -[**deleteCollectionServiceCIDR**](NetworkingV1alpha1Api.md#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1alpha1/servicecidrs | -[**deleteIPAddress**](NetworkingV1alpha1Api.md#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1alpha1/ipaddresses/{name} | -[**deleteServiceCIDR**](NetworkingV1alpha1Api.md#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1alpha1/servicecidrs/{name} | -[**getAPIResources**](NetworkingV1alpha1Api.md#getAPIResources) | **GET** /apis/networking.k8s.io/v1alpha1/ | -[**listIPAddress**](NetworkingV1alpha1Api.md#listIPAddress) | **GET** /apis/networking.k8s.io/v1alpha1/ipaddresses | -[**listServiceCIDR**](NetworkingV1alpha1Api.md#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1alpha1/servicecidrs | -[**patchIPAddress**](NetworkingV1alpha1Api.md#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1alpha1/ipaddresses/{name} | -[**patchServiceCIDR**](NetworkingV1alpha1Api.md#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1alpha1/servicecidrs/{name} | -[**patchServiceCIDRStatus**](NetworkingV1alpha1Api.md#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1alpha1/servicecidrs/{name}/status | -[**readIPAddress**](NetworkingV1alpha1Api.md#readIPAddress) | **GET** /apis/networking.k8s.io/v1alpha1/ipaddresses/{name} | -[**readServiceCIDR**](NetworkingV1alpha1Api.md#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1alpha1/servicecidrs/{name} | -[**readServiceCIDRStatus**](NetworkingV1alpha1Api.md#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1alpha1/servicecidrs/{name}/status | -[**replaceIPAddress**](NetworkingV1alpha1Api.md#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1alpha1/ipaddresses/{name} | -[**replaceServiceCIDR**](NetworkingV1alpha1Api.md#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1alpha1/servicecidrs/{name} | -[**replaceServiceCIDRStatus**](NetworkingV1alpha1Api.md#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1alpha1/servicecidrs/{name}/status | - - -# **createIPAddress** -> V1alpha1IPAddress createIPAddress(body) - -create an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiCreateIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiCreateIPAddressRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1IPAddress**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createServiceCIDR** -> V1alpha1ServiceCIDR createServiceCIDR(body) - -create a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiCreateServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiCreateServiceCIDRRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1ServiceCIDR**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionIPAddress** -> V1Status deleteCollectionIPAddress() - -delete collection of IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiDeleteCollectionIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiDeleteCollectionIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionServiceCIDR** -> V1Status deleteCollectionServiceCIDR() - -delete collection of ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiDeleteCollectionServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiDeleteCollectionServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteIPAddress** -> V1Status deleteIPAddress() - -delete an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiDeleteIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiDeleteIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteServiceCIDR** -> V1Status deleteServiceCIDR() - -delete a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiDeleteServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiDeleteServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listIPAddress** -> V1alpha1IPAddressList listIPAddress() - -list or watch objects of kind IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiListIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiListIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha1IPAddressList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listServiceCIDR** -> V1alpha1ServiceCIDRList listServiceCIDR() - -list or watch objects of kind ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiListServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiListServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha1ServiceCIDRList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchIPAddress** -> V1alpha1IPAddress patchIPAddress(body) - -partially update the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiPatchIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiPatchIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchServiceCIDR** -> V1alpha1ServiceCIDR patchServiceCIDR(body) - -partially update the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiPatchServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiPatchServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchServiceCIDRStatus** -> V1alpha1ServiceCIDR patchServiceCIDRStatus(body) - -partially update status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiPatchServiceCIDRStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiPatchServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readIPAddress** -> V1alpha1IPAddress readIPAddress() - -read the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiReadIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiReadIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readServiceCIDR** -> V1alpha1ServiceCIDR readServiceCIDR() - -read the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiReadServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiReadServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readServiceCIDRStatus** -> V1alpha1ServiceCIDR readServiceCIDRStatus() - -read status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiReadServiceCIDRStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiReadServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceIPAddress** -> V1alpha1IPAddress replaceIPAddress(body) - -replace the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiReplaceIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiReplaceIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1IPAddress**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceServiceCIDR** -> V1alpha1ServiceCIDR replaceServiceCIDR(body) - -replace the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiReplaceServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiReplaceServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceServiceCIDRStatus** -> V1alpha1ServiceCIDR replaceServiceCIDRStatus(body) - -replace status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1alpha1Api } from ''; -import type { NetworkingV1alpha1ApiReplaceServiceCIDRStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1alpha1Api(configuration); - -const request: NetworkingV1alpha1ApiReplaceServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/NetworkingV1beta1Api.md b/src/gen/NetworkingV1beta1Api.md deleted file mode 100644 index 5157414b61..0000000000 --- a/src/gen/NetworkingV1beta1Api.md +++ /dev/null @@ -1,1670 +0,0 @@ -# .NetworkingV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createIPAddress**](NetworkingV1beta1Api.md#createIPAddress) | **POST** /apis/networking.k8s.io/v1beta1/ipaddresses | -[**createServiceCIDR**](NetworkingV1beta1Api.md#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1beta1/servicecidrs | -[**deleteCollectionIPAddress**](NetworkingV1beta1Api.md#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses | -[**deleteCollectionServiceCIDR**](NetworkingV1beta1Api.md#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs | -[**deleteIPAddress**](NetworkingV1beta1Api.md#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**deleteServiceCIDR**](NetworkingV1beta1Api.md#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**getAPIResources**](NetworkingV1beta1Api.md#getAPIResources) | **GET** /apis/networking.k8s.io/v1beta1/ | -[**listIPAddress**](NetworkingV1beta1Api.md#listIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses | -[**listServiceCIDR**](NetworkingV1beta1Api.md#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs | -[**patchIPAddress**](NetworkingV1beta1Api.md#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**patchServiceCIDR**](NetworkingV1beta1Api.md#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**patchServiceCIDRStatus**](NetworkingV1beta1Api.md#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | -[**readIPAddress**](NetworkingV1beta1Api.md#readIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**readServiceCIDR**](NetworkingV1beta1Api.md#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**readServiceCIDRStatus**](NetworkingV1beta1Api.md#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | -[**replaceIPAddress**](NetworkingV1beta1Api.md#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**replaceServiceCIDR**](NetworkingV1beta1Api.md#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**replaceServiceCIDRStatus**](NetworkingV1beta1Api.md#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | - - -# **createIPAddress** -> V1beta1IPAddress createIPAddress(body) - -create an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiCreateIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiCreateIPAddressRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1IPAddress**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createServiceCIDR** -> V1beta1ServiceCIDR createServiceCIDR(body) - -create a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiCreateServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiCreateServiceCIDRRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ServiceCIDR**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionIPAddress** -> V1Status deleteCollectionIPAddress() - -delete collection of IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiDeleteCollectionIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteCollectionIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionServiceCIDR** -> V1Status deleteCollectionServiceCIDR() - -delete collection of ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteIPAddress** -> V1Status deleteIPAddress() - -delete an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiDeleteIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteServiceCIDR** -> V1Status deleteServiceCIDR() - -delete a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiDeleteServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listIPAddress** -> V1beta1IPAddressList listIPAddress() - -list or watch objects of kind IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiListIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiListIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1IPAddressList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listServiceCIDR** -> V1beta1ServiceCIDRList listServiceCIDR() - -list or watch objects of kind ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiListServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiListServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1ServiceCIDRList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchIPAddress** -> V1beta1IPAddress patchIPAddress(body) - -partially update the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiPatchIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiPatchIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchServiceCIDR** -> V1beta1ServiceCIDR patchServiceCIDR(body) - -partially update the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiPatchServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiPatchServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchServiceCIDRStatus** -> V1beta1ServiceCIDR patchServiceCIDRStatus(body) - -partially update status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiPatchServiceCIDRStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiPatchServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readIPAddress** -> V1beta1IPAddress readIPAddress() - -read the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiReadIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReadIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readServiceCIDR** -> V1beta1ServiceCIDR readServiceCIDR() - -read the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiReadServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReadServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readServiceCIDRStatus** -> V1beta1ServiceCIDR readServiceCIDRStatus() - -read status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiReadServiceCIDRStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReadServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceIPAddress** -> V1beta1IPAddress replaceIPAddress(body) - -replace the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiReplaceIPAddressRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReplaceIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1IPAddress**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1IPAddress** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceServiceCIDR** -> V1beta1ServiceCIDR replaceServiceCIDR(body) - -replace the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiReplaceServiceCIDRRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReplaceServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceServiceCIDRStatus** -> V1beta1ServiceCIDR replaceServiceCIDRStatus(body) - -replace status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from ''; -import type { NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ServiceCIDR** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/NodeApi.md b/src/gen/NodeApi.md deleted file mode 100644 index a5acdcc5cf..0000000000 --- a/src/gen/NodeApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .NodeApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](NodeApi.md#getAPIGroup) | **GET** /apis/node.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, NodeApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NodeApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/NodeV1Api.md b/src/gen/NodeV1Api.md deleted file mode 100644 index cfd84365e1..0000000000 --- a/src/gen/NodeV1Api.md +++ /dev/null @@ -1,746 +0,0 @@ -# .NodeV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createRuntimeClass**](NodeV1Api.md#createRuntimeClass) | **POST** /apis/node.k8s.io/v1/runtimeclasses | -[**deleteCollectionRuntimeClass**](NodeV1Api.md#deleteCollectionRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses | -[**deleteRuntimeClass**](NodeV1Api.md#deleteRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses/{name} | -[**getAPIResources**](NodeV1Api.md#getAPIResources) | **GET** /apis/node.k8s.io/v1/ | -[**listRuntimeClass**](NodeV1Api.md#listRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses | -[**patchRuntimeClass**](NodeV1Api.md#patchRuntimeClass) | **PATCH** /apis/node.k8s.io/v1/runtimeclasses/{name} | -[**readRuntimeClass**](NodeV1Api.md#readRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses/{name} | -[**replaceRuntimeClass**](NodeV1Api.md#replaceRuntimeClass) | **PUT** /apis/node.k8s.io/v1/runtimeclasses/{name} | - - -# **createRuntimeClass** -> V1RuntimeClass createRuntimeClass(body) - -create a RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from ''; -import type { NodeV1ApiCreateRuntimeClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiCreateRuntimeClassRequest = { - - body: { - apiVersion: "apiVersion_example", - handler: "handler_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - overhead: { - podFixed: { - "key": "key_example", - }, - }, - scheduling: { - nodeSelector: { - "key": "key_example", - }, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RuntimeClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1RuntimeClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionRuntimeClass** -> V1Status deleteCollectionRuntimeClass() - -delete collection of RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from ''; -import type { NodeV1ApiDeleteCollectionRuntimeClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiDeleteCollectionRuntimeClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteRuntimeClass** -> V1Status deleteRuntimeClass() - -delete a RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from ''; -import type { NodeV1ApiDeleteRuntimeClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiDeleteRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listRuntimeClass** -> V1RuntimeClassList listRuntimeClass() - -list or watch objects of kind RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from ''; -import type { NodeV1ApiListRuntimeClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiListRuntimeClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1RuntimeClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchRuntimeClass** -> V1RuntimeClass patchRuntimeClass(body) - -partially update the specified RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from ''; -import type { NodeV1ApiPatchRuntimeClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiPatchRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1RuntimeClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readRuntimeClass** -> V1RuntimeClass readRuntimeClass() - -read the specified RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from ''; -import type { NodeV1ApiReadRuntimeClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiReadRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1RuntimeClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceRuntimeClass** -> V1RuntimeClass replaceRuntimeClass(body) - -replace the specified RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from ''; -import type { NodeV1ApiReplaceRuntimeClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiReplaceRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - handler: "handler_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - overhead: { - podFixed: { - "key": "key_example", - }, - }, - scheduling: { - nodeSelector: { - "key": "key_example", - }, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RuntimeClass**| | - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1RuntimeClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/OpenidApi.md b/src/gen/OpenidApi.md deleted file mode 100644 index a9714d17a5..0000000000 --- a/src/gen/OpenidApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .OpenidApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getServiceAccountIssuerOpenIDKeyset**](OpenidApi.md#getServiceAccountIssuerOpenIDKeyset) | **GET** /openid/v1/jwks | - - -# **getServiceAccountIssuerOpenIDKeyset** -> string getServiceAccountIssuerOpenIDKeyset() - -get service account issuer OpenID JSON Web Key Set (contains public token verification keys) - -### Example - - -```typescript -import { createConfiguration, OpenidApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new OpenidApi(configuration); - -const request = {}; - -const data = await apiInstance.getServiceAccountIssuerOpenIDKeyset(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/jwk-set+json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/PolicyApi.md b/src/gen/PolicyApi.md deleted file mode 100644 index 0820843253..0000000000 --- a/src/gen/PolicyApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .PolicyApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](PolicyApi.md#getAPIGroup) | **GET** /apis/policy/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, PolicyApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/PolicyV1Api.md b/src/gen/PolicyV1Api.md deleted file mode 100644 index 732f6b89ea..0000000000 --- a/src/gen/PolicyV1Api.md +++ /dev/null @@ -1,1186 +0,0 @@ -# .PolicyV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedPodDisruptionBudget**](PolicyV1Api.md#createNamespacedPodDisruptionBudget) | **POST** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | -[**deleteCollectionNamespacedPodDisruptionBudget**](PolicyV1Api.md#deleteCollectionNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | -[**deleteNamespacedPodDisruptionBudget**](PolicyV1Api.md#deleteNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**getAPIResources**](PolicyV1Api.md#getAPIResources) | **GET** /apis/policy/v1/ | -[**listNamespacedPodDisruptionBudget**](PolicyV1Api.md#listNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | -[**listPodDisruptionBudgetForAllNamespaces**](PolicyV1Api.md#listPodDisruptionBudgetForAllNamespaces) | **GET** /apis/policy/v1/poddisruptionbudgets | -[**patchNamespacedPodDisruptionBudget**](PolicyV1Api.md#patchNamespacedPodDisruptionBudget) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**patchNamespacedPodDisruptionBudgetStatus**](PolicyV1Api.md#patchNamespacedPodDisruptionBudgetStatus) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | -[**readNamespacedPodDisruptionBudget**](PolicyV1Api.md#readNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**readNamespacedPodDisruptionBudgetStatus**](PolicyV1Api.md#readNamespacedPodDisruptionBudgetStatus) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | -[**replaceNamespacedPodDisruptionBudget**](PolicyV1Api.md#replaceNamespacedPodDisruptionBudget) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**replaceNamespacedPodDisruptionBudgetStatus**](PolicyV1Api.md#replaceNamespacedPodDisruptionBudgetStatus) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | - - -# **createNamespacedPodDisruptionBudget** -> V1PodDisruptionBudget createNamespacedPodDisruptionBudget(body) - -create a PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxUnavailable: "maxUnavailable_example", - minAvailable: "minAvailable_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentHealthy: 1, - desiredHealthy: 1, - disruptedPods: { - "key": new Date('1970-01-01T00:00:00.00Z'), - }, - disruptionsAllowed: 1, - expectedPods: 1, - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodDisruptionBudget**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PodDisruptionBudget** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedPodDisruptionBudget** -> V1Status deleteCollectionNamespacedPodDisruptionBudget() - -delete collection of PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedPodDisruptionBudget** -> V1Status deleteNamespacedPodDisruptionBudget() - -delete a PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedPodDisruptionBudget** -> V1PodDisruptionBudgetList listNamespacedPodDisruptionBudget() - -list or watch objects of kind PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiListNamespacedPodDisruptionBudgetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiListNamespacedPodDisruptionBudgetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PodDisruptionBudgetList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listPodDisruptionBudgetForAllNamespaces** -> V1PodDisruptionBudgetList listPodDisruptionBudgetForAllNamespaces() - -list or watch objects of kind PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodDisruptionBudgetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PodDisruptionBudgetList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPodDisruptionBudget** -> V1PodDisruptionBudget patchNamespacedPodDisruptionBudget(body) - -partially update the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1PodDisruptionBudget** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPodDisruptionBudgetStatus** -> V1PodDisruptionBudget patchNamespacedPodDisruptionBudgetStatus(body) - -partially update status of the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodDisruptionBudgetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1PodDisruptionBudget** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodDisruptionBudget** -> V1PodDisruptionBudget readNamespacedPodDisruptionBudget() - -read the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1PodDisruptionBudget** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodDisruptionBudgetStatus** -> V1PodDisruptionBudget readNamespacedPodDisruptionBudgetStatus() - -read status of the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodDisruptionBudgetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1PodDisruptionBudget** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPodDisruptionBudget** -> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudget(body) - -replace the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxUnavailable: "maxUnavailable_example", - minAvailable: "minAvailable_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentHealthy: 1, - desiredHealthy: 1, - disruptedPods: { - "key": new Date('1970-01-01T00:00:00.00Z'), - }, - disruptionsAllowed: 1, - expectedPods: 1, - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodDisruptionBudget**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PodDisruptionBudget** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPodDisruptionBudgetStatus** -> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudgetStatus(body) - -replace status of the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from ''; -import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxUnavailable: "maxUnavailable_example", - minAvailable: "minAvailable_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentHealthy: 1, - desiredHealthy: 1, - disruptedPods: { - "key": new Date('1970-01-01T00:00:00.00Z'), - }, - disruptionsAllowed: 1, - expectedPods: 1, - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodDisruptionBudgetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodDisruptionBudget**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PodDisruptionBudget** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/README.md b/src/gen/README.md deleted file mode 100644 index 902661a251..0000000000 --- a/src/gen/README.md +++ /dev/null @@ -1,80 +0,0 @@ -## kubernetes-client-typescript@0.8-SNAPSHOT - -This generator creates TypeScript/JavaScript client that utilizes fetch-api. - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run ```npm publish``` - -### Consuming - -Navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install kubernetes-client-typescript@0.8-SNAPSHOT --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` - -### Usage - -Below code snippet shows exemplary usage of the configuration and the API based -on the typical `PetStore` example used for OpenAPI. - -``` -import * as your_api from 'your_api_package' - -// Covers all auth methods included in your OpenAPI yaml definition -const authConfig: your_api.AuthMethodsConfiguration = { - "api_key": "YOUR_API_KEY" -} - -// Implements a simple middleware to modify requests before (`pre`) they are sent -// and after (`post`) they have been received -class Test implements your_api.Middleware { - pre(context: your_api.RequestContext): Promise { - // Modify context here and return - return Promise.resolve(context); - } - - post(context: your_api.ResponseContext): Promise { - return Promise.resolve(context); - } - -} - -// Create configuration parameter object -const configurationParameters = { - httpApi: new your_api.JQueryHttpLibrary(), // Can also be ignored - default is usually fine - baseServer: your_api.servers[0], // First server is default - authMethods: authConfig, // No auth is default - promiseMiddleware: [new Test()], -} - -// Convert to actual configuration -const config = your_api.createConfiguration(configurationParameters); - -// Use configuration with your_api -const api = new your_api.PetApi(config); -your_api.Pet p = new your_api.Pet(); -p.name = "My new pet"; -p.photoUrls = []; -p.tags = []; -p.status = "available"; -Promise createdPet = api.addPet(p); - -``` diff --git a/src/gen/RbacAuthorizationApi.md b/src/gen/RbacAuthorizationApi.md deleted file mode 100644 index e34f61bcf1..0000000000 --- a/src/gen/RbacAuthorizationApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .RbacAuthorizationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](RbacAuthorizationApi.md#getAPIGroup) | **GET** /apis/rbac.authorization.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/RbacAuthorizationV1Api.md b/src/gen/RbacAuthorizationV1Api.md deleted file mode 100644 index 29a6b2fc6f..0000000000 --- a/src/gen/RbacAuthorizationV1Api.md +++ /dev/null @@ -1,3029 +0,0 @@ -# .RbacAuthorizationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterRole**](RbacAuthorizationV1Api.md#createClusterRole) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterroles | -[**createClusterRoleBinding**](RbacAuthorizationV1Api.md#createClusterRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | -[**createNamespacedRole**](RbacAuthorizationV1Api.md#createNamespacedRole) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | -[**createNamespacedRoleBinding**](RbacAuthorizationV1Api.md#createNamespacedRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | -[**deleteClusterRole**](RbacAuthorizationV1Api.md#deleteClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**deleteClusterRoleBinding**](RbacAuthorizationV1Api.md#deleteClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**deleteCollectionClusterRole**](RbacAuthorizationV1Api.md#deleteCollectionClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles | -[**deleteCollectionClusterRoleBinding**](RbacAuthorizationV1Api.md#deleteCollectionClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | -[**deleteCollectionNamespacedRole**](RbacAuthorizationV1Api.md#deleteCollectionNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | -[**deleteCollectionNamespacedRoleBinding**](RbacAuthorizationV1Api.md#deleteCollectionNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | -[**deleteNamespacedRole**](RbacAuthorizationV1Api.md#deleteNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**deleteNamespacedRoleBinding**](RbacAuthorizationV1Api.md#deleteNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | -[**getAPIResources**](RbacAuthorizationV1Api.md#getAPIResources) | **GET** /apis/rbac.authorization.k8s.io/v1/ | -[**listClusterRole**](RbacAuthorizationV1Api.md#listClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles | -[**listClusterRoleBinding**](RbacAuthorizationV1Api.md#listClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | -[**listNamespacedRole**](RbacAuthorizationV1Api.md#listNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | -[**listNamespacedRoleBinding**](RbacAuthorizationV1Api.md#listNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | -[**listRoleBindingForAllNamespaces**](RbacAuthorizationV1Api.md#listRoleBindingForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/rolebindings | -[**listRoleForAllNamespaces**](RbacAuthorizationV1Api.md#listRoleForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/roles | -[**patchClusterRole**](RbacAuthorizationV1Api.md#patchClusterRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**patchClusterRoleBinding**](RbacAuthorizationV1Api.md#patchClusterRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**patchNamespacedRole**](RbacAuthorizationV1Api.md#patchNamespacedRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**patchNamespacedRoleBinding**](RbacAuthorizationV1Api.md#patchNamespacedRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | -[**readClusterRole**](RbacAuthorizationV1Api.md#readClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**readClusterRoleBinding**](RbacAuthorizationV1Api.md#readClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**readNamespacedRole**](RbacAuthorizationV1Api.md#readNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**readNamespacedRoleBinding**](RbacAuthorizationV1Api.md#readNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | -[**replaceClusterRole**](RbacAuthorizationV1Api.md#replaceClusterRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**replaceClusterRoleBinding**](RbacAuthorizationV1Api.md#replaceClusterRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**replaceNamespacedRole**](RbacAuthorizationV1Api.md#replaceNamespacedRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**replaceNamespacedRoleBinding**](RbacAuthorizationV1Api.md#replaceNamespacedRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | - - -# **createClusterRole** -> V1ClusterRole createClusterRole(body) - -create a ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiCreateClusterRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateClusterRoleRequest = { - - body: { - aggregationRule: { - clusterRoleSelectors: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - ], - }, - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRole**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ClusterRole** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createClusterRoleBinding** -> V1ClusterRoleBinding createClusterRoleBinding(body) - -create a ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiCreateClusterRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateClusterRoleBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRoleBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ClusterRoleBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedRole** -> V1Role createNamespacedRole(body) - -create a Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiCreateNamespacedRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateNamespacedRoleRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Role**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Role** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedRoleBinding** -> V1RoleBinding createNamespacedRoleBinding(body) - -create a RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RoleBinding**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1RoleBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteClusterRole** -> V1Status deleteClusterRole() - -delete a ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiDeleteClusterRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteClusterRoleBinding** -> V1Status deleteClusterRoleBinding() - -delete a ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionClusterRole** -> V1Status deleteCollectionClusterRole() - -delete collection of ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionClusterRoleBinding** -> V1Status deleteCollectionClusterRoleBinding() - -delete collection of ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedRole** -> V1Status deleteCollectionNamespacedRole() - -delete collection of Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedRoleBinding** -> V1Status deleteCollectionNamespacedRoleBinding() - -delete collection of RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedRole** -> V1Status deleteNamespacedRole() - -delete a Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiDeleteNamespacedRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedRoleBinding** -> V1Status deleteNamespacedRoleBinding() - -delete a RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listClusterRole** -> V1ClusterRoleList listClusterRole() - -list or watch objects of kind ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiListClusterRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListClusterRoleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ClusterRoleList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listClusterRoleBinding** -> V1ClusterRoleBindingList listClusterRoleBinding() - -list or watch objects of kind ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiListClusterRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListClusterRoleBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ClusterRoleBindingList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedRole** -> V1RoleList listNamespacedRole() - -list or watch objects of kind Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiListNamespacedRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListNamespacedRoleRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1RoleList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedRoleBinding** -> V1RoleBindingList listNamespacedRoleBinding() - -list or watch objects of kind RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiListNamespacedRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListNamespacedRoleBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1RoleBindingList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listRoleBindingForAllNamespaces** -> V1RoleBindingList listRoleBindingForAllNamespaces() - -list or watch objects of kind RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listRoleBindingForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1RoleBindingList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listRoleForAllNamespaces** -> V1RoleList listRoleForAllNamespaces() - -list or watch objects of kind Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiListRoleForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListRoleForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listRoleForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1RoleList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchClusterRole** -> V1ClusterRole patchClusterRole(body) - -partially update the specified ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiPatchClusterRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ClusterRole** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchClusterRoleBinding** -> V1ClusterRoleBinding patchClusterRoleBinding(body) - -partially update the specified ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiPatchClusterRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ClusterRoleBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedRole** -> V1Role patchNamespacedRole(body) - -partially update the specified Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiPatchNamespacedRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1Role** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedRoleBinding** -> V1RoleBinding patchNamespacedRoleBinding(body) - -partially update the specified RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1RoleBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readClusterRole** -> V1ClusterRole readClusterRole() - -read the specified ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiReadClusterRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ClusterRole** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readClusterRoleBinding** -> V1ClusterRoleBinding readClusterRoleBinding() - -read the specified ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiReadClusterRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ClusterRoleBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedRole** -> V1Role readNamespacedRole() - -read the specified Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiReadNamespacedRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1Role** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedRoleBinding** -> V1RoleBinding readNamespacedRoleBinding() - -read the specified RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1RoleBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceClusterRole** -> V1ClusterRole replaceClusterRole(body) - -replace the specified ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiReplaceClusterRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - - body: { - aggregationRule: { - clusterRoleSelectors: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - ], - }, - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRole**| | - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ClusterRole** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceClusterRoleBinding** -> V1ClusterRoleBinding replaceClusterRoleBinding(body) - -replace the specified ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRoleBinding**| | - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ClusterRoleBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedRole** -> V1Role replaceNamespacedRole(body) - -replace the specified Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiReplaceNamespacedRoleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Role**| | - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1Role** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedRoleBinding** -> V1RoleBinding replaceNamespacedRoleBinding(body) - -replace the specified RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from ''; -import type { RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RoleBinding**| | - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1RoleBinding** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ResourceApi.md b/src/gen/ResourceApi.md deleted file mode 100644 index 50b9ec10a7..0000000000 --- a/src/gen/ResourceApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .ResourceApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](ResourceApi.md#getAPIGroup) | **GET** /apis/resource.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, ResourceApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ResourceV1Api.md b/src/gen/ResourceV1Api.md deleted file mode 100644 index 65c694ad1e..0000000000 --- a/src/gen/ResourceV1Api.md +++ /dev/null @@ -1,4238 +0,0 @@ -# .ResourceV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceClass**](ResourceV1Api.md#createDeviceClass) | **POST** /apis/resource.k8s.io/v1/deviceclasses | -[**createNamespacedResourceClaim**](ResourceV1Api.md#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | -[**createNamespacedResourceClaimTemplate**](ResourceV1Api.md#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | -[**createResourceSlice**](ResourceV1Api.md#createResourceSlice) | **POST** /apis/resource.k8s.io/v1/resourceslices | -[**deleteCollectionDeviceClass**](ResourceV1Api.md#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses | -[**deleteCollectionNamespacedResourceClaim**](ResourceV1Api.md#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | -[**deleteCollectionNamespacedResourceClaimTemplate**](ResourceV1Api.md#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | -[**deleteCollectionResourceSlice**](ResourceV1Api.md#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices | -[**deleteDeviceClass**](ResourceV1Api.md#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**deleteNamespacedResourceClaim**](ResourceV1Api.md#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**deleteNamespacedResourceClaimTemplate**](ResourceV1Api.md#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**deleteResourceSlice**](ResourceV1Api.md#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices/{name} | -[**getAPIResources**](ResourceV1Api.md#getAPIResources) | **GET** /apis/resource.k8s.io/v1/ | -[**listDeviceClass**](ResourceV1Api.md#listDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses | -[**listNamespacedResourceClaim**](ResourceV1Api.md#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | -[**listNamespacedResourceClaimTemplate**](ResourceV1Api.md#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | -[**listResourceClaimForAllNamespaces**](ResourceV1Api.md#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaims | -[**listResourceClaimTemplateForAllNamespaces**](ResourceV1Api.md#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaimtemplates | -[**listResourceSlice**](ResourceV1Api.md#listResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices | -[**patchDeviceClass**](ResourceV1Api.md#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**patchNamespacedResourceClaim**](ResourceV1Api.md#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**patchNamespacedResourceClaimStatus**](ResourceV1Api.md#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | -[**patchNamespacedResourceClaimTemplate**](ResourceV1Api.md#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**patchResourceSlice**](ResourceV1Api.md#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1/resourceslices/{name} | -[**readDeviceClass**](ResourceV1Api.md#readDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**readNamespacedResourceClaim**](ResourceV1Api.md#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**readNamespacedResourceClaimStatus**](ResourceV1Api.md#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | -[**readNamespacedResourceClaimTemplate**](ResourceV1Api.md#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**readResourceSlice**](ResourceV1Api.md#readResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices/{name} | -[**replaceDeviceClass**](ResourceV1Api.md#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**replaceNamespacedResourceClaim**](ResourceV1Api.md#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**replaceNamespacedResourceClaimStatus**](ResourceV1Api.md#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | -[**replaceNamespacedResourceClaimTemplate**](ResourceV1Api.md#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**replaceResourceSlice**](ResourceV1Api.md#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1/resourceslices/{name} | - - -# **createDeviceClass** -> V1DeviceClass createDeviceClass(body) - -create a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiCreateDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateDeviceClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeviceClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceClaim** -> ResourceV1ResourceClaim createNamespacedResourceClaim(body) - -create a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiCreateNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **ResourceV1ResourceClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**ResourceV1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceClaimTemplate** -> V1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) - -create a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceClaimTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createResourceSlice** -> V1ResourceSlice createResourceSlice(body) - -create a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiCreateResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateResourceSliceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceSlice**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionDeviceClass** -> V1Status deleteCollectionDeviceClass() - -delete collection of DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiDeleteCollectionDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceClaim** -> V1Status deleteCollectionNamespacedResourceClaim() - -delete collection of ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceClaimTemplate** -> V1Status deleteCollectionNamespacedResourceClaimTemplate() - -delete collection of ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionResourceSlice** -> V1Status deleteCollectionResourceSlice() - -delete collection of ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiDeleteCollectionResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteDeviceClass** -> V1DeviceClass deleteDeviceClass() - -delete a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiDeleteDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceClaim** -> ResourceV1ResourceClaim deleteNamespacedResourceClaim() - -delete a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiDeleteNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**ResourceV1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceClaimTemplate** -> V1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() - -delete a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteResourceSlice** -> V1ResourceSlice deleteResourceSlice() - -delete a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiDeleteResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listDeviceClass** -> V1DeviceClassList listDeviceClass() - -list or watch objects of kind DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiListDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1DeviceClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceClaim** -> V1ResourceClaimList listNamespacedResourceClaim() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiListNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ResourceClaimList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceClaimTemplate** -> V1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiListNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ResourceClaimTemplateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClaimForAllNamespaces** -> V1ResourceClaimList listResourceClaimForAllNamespaces() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiListResourceClaimForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListResourceClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ResourceClaimList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClaimTemplateForAllNamespaces** -> V1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ResourceClaimTemplateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceSlice** -> V1ResourceSliceList listResourceSlice() - -list or watch objects of kind ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiListResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1ResourceSliceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchDeviceClass** -> V1DeviceClass patchDeviceClass(body) - -partially update the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiPatchDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaim** -> ResourceV1ResourceClaim patchNamespacedResourceClaim(body) - -partially update the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiPatchNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**ResourceV1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaimStatus** -> ResourceV1ResourceClaim patchNamespacedResourceClaimStatus(body) - -partially update status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiPatchNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**ResourceV1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaimTemplate** -> V1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) - -partially update the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchResourceSlice** -> V1ResourceSlice patchResourceSlice(body) - -partially update the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiPatchResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readDeviceClass** -> V1DeviceClass readDeviceClass() - -read the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiReadDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaim** -> ResourceV1ResourceClaim readNamespacedResourceClaim() - -read the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiReadNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**ResourceV1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaimStatus** -> ResourceV1ResourceClaim readNamespacedResourceClaimStatus() - -read status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiReadNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**ResourceV1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaimTemplate** -> V1ResourceClaimTemplate readNamespacedResourceClaimTemplate() - -read the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiReadNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readResourceSlice** -> V1ResourceSlice readResourceSlice() - -read the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiReadResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceDeviceClass** -> V1DeviceClass replaceDeviceClass(body) - -replace the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiReplaceDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeviceClass**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaim** -> ResourceV1ResourceClaim replaceNamespacedResourceClaim(body) - -replace the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiReplaceNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **ResourceV1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**ResourceV1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaimStatus** -> ResourceV1ResourceClaim replaceNamespacedResourceClaimStatus(body) - -replace status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **ResourceV1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**ResourceV1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaimTemplate** -> V1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) - -replace the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceClaimTemplate**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceResourceSlice** -> V1ResourceSlice replaceResourceSlice(body) - -replace the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from ''; -import type { ResourceV1ApiReplaceResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceSlice**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ResourceV1alpha2Api.md b/src/gen/ResourceV1alpha2Api.md deleted file mode 100644 index e4ae8f3fd6..0000000000 --- a/src/gen/ResourceV1alpha2Api.md +++ /dev/null @@ -1,6145 +0,0 @@ -# .ResourceV1alpha2Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedPodSchedulingContext**](ResourceV1alpha2Api.md#createNamespacedPodSchedulingContext) | **POST** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts | -[**createNamespacedResourceClaim**](ResourceV1alpha2Api.md#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims | -[**createNamespacedResourceClaimParameters**](ResourceV1alpha2Api.md#createNamespacedResourceClaimParameters) | **POST** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters | -[**createNamespacedResourceClaimTemplate**](ResourceV1alpha2Api.md#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates | -[**createNamespacedResourceClassParameters**](ResourceV1alpha2Api.md#createNamespacedResourceClassParameters) | **POST** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclassparameters | -[**createResourceClass**](ResourceV1alpha2Api.md#createResourceClass) | **POST** /apis/resource.k8s.io/v1alpha2/resourceclasses | -[**createResourceSlice**](ResourceV1alpha2Api.md#createResourceSlice) | **POST** /apis/resource.k8s.io/v1alpha2/resourceslices | -[**deleteCollectionNamespacedPodSchedulingContext**](ResourceV1alpha2Api.md#deleteCollectionNamespacedPodSchedulingContext) | **DELETE** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts | -[**deleteCollectionNamespacedResourceClaim**](ResourceV1alpha2Api.md#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims | -[**deleteCollectionNamespacedResourceClaimParameters**](ResourceV1alpha2Api.md#deleteCollectionNamespacedResourceClaimParameters) | **DELETE** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters | -[**deleteCollectionNamespacedResourceClaimTemplate**](ResourceV1alpha2Api.md#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates | -[**deleteCollectionNamespacedResourceClassParameters**](ResourceV1alpha2Api.md#deleteCollectionNamespacedResourceClassParameters) | **DELETE** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclassparameters | -[**deleteCollectionResourceClass**](ResourceV1alpha2Api.md#deleteCollectionResourceClass) | **DELETE** /apis/resource.k8s.io/v1alpha2/resourceclasses | -[**deleteCollectionResourceSlice**](ResourceV1alpha2Api.md#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1alpha2/resourceslices | -[**deleteNamespacedPodSchedulingContext**](ResourceV1alpha2Api.md#deleteNamespacedPodSchedulingContext) | **DELETE** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name} | -[**deleteNamespacedResourceClaim**](ResourceV1alpha2Api.md#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name} | -[**deleteNamespacedResourceClaimParameters**](ResourceV1alpha2Api.md#deleteNamespacedResourceClaimParameters) | **DELETE** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters/{name} | -[**deleteNamespacedResourceClaimTemplate**](ResourceV1alpha2Api.md#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**deleteNamespacedResourceClassParameters**](ResourceV1alpha2Api.md#deleteNamespacedResourceClassParameters) | **DELETE** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclassparameters/{name} | -[**deleteResourceClass**](ResourceV1alpha2Api.md#deleteResourceClass) | **DELETE** /apis/resource.k8s.io/v1alpha2/resourceclasses/{name} | -[**deleteResourceSlice**](ResourceV1alpha2Api.md#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1alpha2/resourceslices/{name} | -[**getAPIResources**](ResourceV1alpha2Api.md#getAPIResources) | **GET** /apis/resource.k8s.io/v1alpha2/ | -[**listNamespacedPodSchedulingContext**](ResourceV1alpha2Api.md#listNamespacedPodSchedulingContext) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts | -[**listNamespacedResourceClaim**](ResourceV1alpha2Api.md#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims | -[**listNamespacedResourceClaimParameters**](ResourceV1alpha2Api.md#listNamespacedResourceClaimParameters) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters | -[**listNamespacedResourceClaimTemplate**](ResourceV1alpha2Api.md#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates | -[**listNamespacedResourceClassParameters**](ResourceV1alpha2Api.md#listNamespacedResourceClassParameters) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclassparameters | -[**listPodSchedulingContextForAllNamespaces**](ResourceV1alpha2Api.md#listPodSchedulingContextForAllNamespaces) | **GET** /apis/resource.k8s.io/v1alpha2/podschedulingcontexts | -[**listResourceClaimForAllNamespaces**](ResourceV1alpha2Api.md#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1alpha2/resourceclaims | -[**listResourceClaimParametersForAllNamespaces**](ResourceV1alpha2Api.md#listResourceClaimParametersForAllNamespaces) | **GET** /apis/resource.k8s.io/v1alpha2/resourceclaimparameters | -[**listResourceClaimTemplateForAllNamespaces**](ResourceV1alpha2Api.md#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1alpha2/resourceclaimtemplates | -[**listResourceClass**](ResourceV1alpha2Api.md#listResourceClass) | **GET** /apis/resource.k8s.io/v1alpha2/resourceclasses | -[**listResourceClassParametersForAllNamespaces**](ResourceV1alpha2Api.md#listResourceClassParametersForAllNamespaces) | **GET** /apis/resource.k8s.io/v1alpha2/resourceclassparameters | -[**listResourceSlice**](ResourceV1alpha2Api.md#listResourceSlice) | **GET** /apis/resource.k8s.io/v1alpha2/resourceslices | -[**patchNamespacedPodSchedulingContext**](ResourceV1alpha2Api.md#patchNamespacedPodSchedulingContext) | **PATCH** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name} | -[**patchNamespacedPodSchedulingContextStatus**](ResourceV1alpha2Api.md#patchNamespacedPodSchedulingContextStatus) | **PATCH** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name}/status | -[**patchNamespacedResourceClaim**](ResourceV1alpha2Api.md#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name} | -[**patchNamespacedResourceClaimParameters**](ResourceV1alpha2Api.md#patchNamespacedResourceClaimParameters) | **PATCH** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters/{name} | -[**patchNamespacedResourceClaimStatus**](ResourceV1alpha2Api.md#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name}/status | -[**patchNamespacedResourceClaimTemplate**](ResourceV1alpha2Api.md#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**patchNamespacedResourceClassParameters**](ResourceV1alpha2Api.md#patchNamespacedResourceClassParameters) | **PATCH** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclassparameters/{name} | -[**patchResourceClass**](ResourceV1alpha2Api.md#patchResourceClass) | **PATCH** /apis/resource.k8s.io/v1alpha2/resourceclasses/{name} | -[**patchResourceSlice**](ResourceV1alpha2Api.md#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1alpha2/resourceslices/{name} | -[**readNamespacedPodSchedulingContext**](ResourceV1alpha2Api.md#readNamespacedPodSchedulingContext) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name} | -[**readNamespacedPodSchedulingContextStatus**](ResourceV1alpha2Api.md#readNamespacedPodSchedulingContextStatus) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name}/status | -[**readNamespacedResourceClaim**](ResourceV1alpha2Api.md#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name} | -[**readNamespacedResourceClaimParameters**](ResourceV1alpha2Api.md#readNamespacedResourceClaimParameters) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters/{name} | -[**readNamespacedResourceClaimStatus**](ResourceV1alpha2Api.md#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name}/status | -[**readNamespacedResourceClaimTemplate**](ResourceV1alpha2Api.md#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**readNamespacedResourceClassParameters**](ResourceV1alpha2Api.md#readNamespacedResourceClassParameters) | **GET** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclassparameters/{name} | -[**readResourceClass**](ResourceV1alpha2Api.md#readResourceClass) | **GET** /apis/resource.k8s.io/v1alpha2/resourceclasses/{name} | -[**readResourceSlice**](ResourceV1alpha2Api.md#readResourceSlice) | **GET** /apis/resource.k8s.io/v1alpha2/resourceslices/{name} | -[**replaceNamespacedPodSchedulingContext**](ResourceV1alpha2Api.md#replaceNamespacedPodSchedulingContext) | **PUT** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name} | -[**replaceNamespacedPodSchedulingContextStatus**](ResourceV1alpha2Api.md#replaceNamespacedPodSchedulingContextStatus) | **PUT** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name}/status | -[**replaceNamespacedResourceClaim**](ResourceV1alpha2Api.md#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name} | -[**replaceNamespacedResourceClaimParameters**](ResourceV1alpha2Api.md#replaceNamespacedResourceClaimParameters) | **PUT** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters/{name} | -[**replaceNamespacedResourceClaimStatus**](ResourceV1alpha2Api.md#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name}/status | -[**replaceNamespacedResourceClaimTemplate**](ResourceV1alpha2Api.md#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**replaceNamespacedResourceClassParameters**](ResourceV1alpha2Api.md#replaceNamespacedResourceClassParameters) | **PUT** /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclassparameters/{name} | -[**replaceResourceClass**](ResourceV1alpha2Api.md#replaceResourceClass) | **PUT** /apis/resource.k8s.io/v1alpha2/resourceclasses/{name} | -[**replaceResourceSlice**](ResourceV1alpha2Api.md#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1alpha2/resourceslices/{name} | - - -# **createNamespacedPodSchedulingContext** -> V1alpha2PodSchedulingContext createNamespacedPodSchedulingContext(body) - -create a PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiCreateNamespacedPodSchedulingContextRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiCreateNamespacedPodSchedulingContextRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - potentialNodes: [ - "potentialNodes_example", - ], - selectedNode: "selectedNode_example", - }, - status: { - resourceClaims: [ - { - name: "name_example", - unsuitableNodes: [ - "unsuitableNodes_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPodSchedulingContext(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2PodSchedulingContext**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2PodSchedulingContext** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceClaim** -> V1alpha2ResourceClaim createNamespacedResourceClaim(body) - -create a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiCreateNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiCreateNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocationMode: "allocationMode_example", - parametersRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - resourceClassName: "resourceClassName_example", - }, - status: { - allocation: { - availableOnNodes: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - resourceHandles: [ - { - data: "data_example", - driverName: "driverName_example", - structuredData: { - nodeName: "nodeName_example", - results: [ - { - namedResources: { - name: "name_example", - }, - vendorRequestParameters: {}, - }, - ], - vendorClaimParameters: {}, - vendorClassParameters: {}, - }, - }, - ], - shareable: true, - }, - deallocationRequested: true, - driverName: "driverName_example", - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceClaimParameters** -> V1alpha2ResourceClaimParameters createNamespacedResourceClaimParameters(body) - -create ResourceClaimParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiCreateNamespacedResourceClaimParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiCreateNamespacedResourceClaimParametersRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - driverRequests: [ - { - driverName: "driverName_example", - requests: [ - { - namedResources: { - selector: "selector_example", - }, - vendorParameters: {}, - }, - ], - vendorParameters: {}, - }, - ], - generatedFrom: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - shareable: true, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClaimParameters**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimParameters** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceClaimTemplate** -> V1alpha2ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) - -create a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiCreateNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiCreateNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocationMode: "allocationMode_example", - parametersRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - resourceClassName: "resourceClassName_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClaimTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceClassParameters** -> V1alpha2ResourceClassParameters createNamespacedResourceClassParameters(body) - -create ResourceClassParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiCreateNamespacedResourceClassParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiCreateNamespacedResourceClassParametersRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - filters: [ - { - driverName: "driverName_example", - namedResources: { - selector: "selector_example", - }, - }, - ], - generatedFrom: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - vendorParameters: [ - { - driverName: "driverName_example", - parameters: {}, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClassParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClassParameters**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClassParameters** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createResourceClass** -> V1alpha2ResourceClass createResourceClass(body) - -create a ResourceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiCreateResourceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiCreateResourceClassRequest = { - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parametersRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - structuredParameters: true, - suitableNodes: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createResourceSlice** -> V1alpha2ResourceSlice createResourceSlice(body) - -create a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiCreateResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiCreateResourceSliceRequest = { - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - namedResources: { - instances: [ - { - attributes: [ - { - bool: true, - _int: 1, - intSlice: { - ints: [ - 1, - ], - }, - name: "name_example", - quantity: "quantity_example", - string: "string_example", - stringSlice: { - strings: [ - "strings_example", - ], - }, - version: "version_example", - }, - ], - name: "name_example", - }, - ], - }, - nodeName: "nodeName_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceSlice**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedPodSchedulingContext** -> V1Status deleteCollectionNamespacedPodSchedulingContext() - -delete collection of PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteCollectionNamespacedPodSchedulingContextRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteCollectionNamespacedPodSchedulingContextRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPodSchedulingContext(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceClaim** -> V1Status deleteCollectionNamespacedResourceClaim() - -delete collection of ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteCollectionNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteCollectionNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceClaimParameters** -> V1Status deleteCollectionNamespacedResourceClaimParameters() - -delete collection of ResourceClaimParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteCollectionNamespacedResourceClaimParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteCollectionNamespacedResourceClaimParametersRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceClaimTemplate** -> V1Status deleteCollectionNamespacedResourceClaimTemplate() - -delete collection of ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceClassParameters** -> V1Status deleteCollectionNamespacedResourceClassParameters() - -delete collection of ResourceClassParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteCollectionNamespacedResourceClassParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteCollectionNamespacedResourceClassParametersRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClassParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionResourceClass** -> V1Status deleteCollectionResourceClass() - -delete collection of ResourceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteCollectionResourceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteCollectionResourceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionResourceSlice** -> V1Status deleteCollectionResourceSlice() - -delete collection of ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteCollectionResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteCollectionResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedPodSchedulingContext** -> V1alpha2PodSchedulingContext deleteNamespacedPodSchedulingContext() - -delete a PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteNamespacedPodSchedulingContextRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteNamespacedPodSchedulingContextRequest = { - // name of the PodSchedulingContext - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPodSchedulingContext(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PodSchedulingContext | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1alpha2PodSchedulingContext** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceClaim** -> V1alpha2ResourceClaim deleteNamespacedResourceClaim() - -delete a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceClaimParameters** -> V1alpha2ResourceClaimParameters deleteNamespacedResourceClaimParameters() - -delete ResourceClaimParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteNamespacedResourceClaimParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteNamespacedResourceClaimParametersRequest = { - // name of the ResourceClaimParameters - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimParameters | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimParameters** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceClaimTemplate** -> V1alpha2ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() - -delete a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceClassParameters** -> V1alpha2ResourceClassParameters deleteNamespacedResourceClassParameters() - -delete ResourceClassParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteNamespacedResourceClassParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteNamespacedResourceClassParametersRequest = { - // name of the ResourceClassParameters - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClassParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClassParameters | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClassParameters** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteResourceClass** -> V1alpha2ResourceClass deleteResourceClass() - -delete a ResourceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteResourceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteResourceClassRequest = { - // name of the ResourceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteResourceSlice** -> V1alpha2ResourceSlice deleteResourceSlice() - -delete a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiDeleteResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiDeleteResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedPodSchedulingContext** -> V1alpha2PodSchedulingContextList listNamespacedPodSchedulingContext() - -list or watch objects of kind PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListNamespacedPodSchedulingContextRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListNamespacedPodSchedulingContextRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPodSchedulingContext(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2PodSchedulingContextList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceClaim** -> V1alpha2ResourceClaimList listNamespacedResourceClaim() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceClaimParameters** -> V1alpha2ResourceClaimParametersList listNamespacedResourceClaimParameters() - -list or watch objects of kind ResourceClaimParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListNamespacedResourceClaimParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListNamespacedResourceClaimParametersRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimParametersList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceClaimTemplate** -> V1alpha2ResourceClaimTemplateList listNamespacedResourceClaimTemplate() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimTemplateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceClassParameters** -> V1alpha2ResourceClassParametersList listNamespacedResourceClassParameters() - -list or watch objects of kind ResourceClassParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListNamespacedResourceClassParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListNamespacedResourceClassParametersRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClassParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClassParametersList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listPodSchedulingContextForAllNamespaces** -> V1alpha2PodSchedulingContextList listPodSchedulingContextForAllNamespaces() - -list or watch objects of kind PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListPodSchedulingContextForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListPodSchedulingContextForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodSchedulingContextForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2PodSchedulingContextList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClaimForAllNamespaces** -> V1alpha2ResourceClaimList listResourceClaimForAllNamespaces() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListResourceClaimForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListResourceClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClaimParametersForAllNamespaces** -> V1alpha2ResourceClaimParametersList listResourceClaimParametersForAllNamespaces() - -list or watch objects of kind ResourceClaimParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListResourceClaimParametersForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListResourceClaimParametersForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimParametersForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimParametersList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClaimTemplateForAllNamespaces** -> V1alpha2ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListResourceClaimTemplateForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListResourceClaimTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimTemplateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClass** -> V1alpha2ResourceClassList listResourceClass() - -list or watch objects of kind ResourceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListResourceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListResourceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClassParametersForAllNamespaces** -> V1alpha2ResourceClassParametersList listResourceClassParametersForAllNamespaces() - -list or watch objects of kind ResourceClassParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListResourceClassParametersForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListResourceClassParametersForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClassParametersForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClassParametersList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceSlice** -> V1alpha2ResourceSliceList listResourceSlice() - -list or watch objects of kind ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiListResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiListResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceSliceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPodSchedulingContext** -> V1alpha2PodSchedulingContext patchNamespacedPodSchedulingContext(body) - -partially update the specified PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiPatchNamespacedPodSchedulingContextRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiPatchNamespacedPodSchedulingContextRequest = { - // name of the PodSchedulingContext - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodSchedulingContext(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodSchedulingContext | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha2PodSchedulingContext** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedPodSchedulingContextStatus** -> V1alpha2PodSchedulingContext patchNamespacedPodSchedulingContextStatus(body) - -partially update status of the specified PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiPatchNamespacedPodSchedulingContextStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiPatchNamespacedPodSchedulingContextStatusRequest = { - // name of the PodSchedulingContext - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodSchedulingContextStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodSchedulingContext | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha2PodSchedulingContext** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaim** -> V1alpha2ResourceClaim patchNamespacedResourceClaim(body) - -partially update the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiPatchNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiPatchNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaimParameters** -> V1alpha2ResourceClaimParameters patchNamespacedResourceClaimParameters(body) - -partially update the specified ResourceClaimParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiPatchNamespacedResourceClaimParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiPatchNamespacedResourceClaimParametersRequest = { - // name of the ResourceClaimParameters - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimParameters | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimParameters** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaimStatus** -> V1alpha2ResourceClaim patchNamespacedResourceClaimStatus(body) - -partially update status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiPatchNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiPatchNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaimTemplate** -> V1alpha2ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) - -partially update the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiPatchNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiPatchNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClassParameters** -> V1alpha2ResourceClassParameters patchNamespacedResourceClassParameters(body) - -partially update the specified ResourceClassParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiPatchNamespacedResourceClassParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiPatchNamespacedResourceClassParametersRequest = { - // name of the ResourceClassParameters - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClassParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClassParameters | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClassParameters** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchResourceClass** -> V1alpha2ResourceClass patchResourceClass(body) - -partially update the specified ResourceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiPatchResourceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiPatchResourceClassRequest = { - // name of the ResourceClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchResourceSlice** -> V1alpha2ResourceSlice patchResourceSlice(body) - -partially update the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiPatchResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiPatchResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodSchedulingContext** -> V1alpha2PodSchedulingContext readNamespacedPodSchedulingContext() - -read the specified PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReadNamespacedPodSchedulingContextRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReadNamespacedPodSchedulingContextRequest = { - // name of the PodSchedulingContext - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodSchedulingContext(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodSchedulingContext | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha2PodSchedulingContext** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedPodSchedulingContextStatus** -> V1alpha2PodSchedulingContext readNamespacedPodSchedulingContextStatus() - -read status of the specified PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReadNamespacedPodSchedulingContextStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReadNamespacedPodSchedulingContextStatusRequest = { - // name of the PodSchedulingContext - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodSchedulingContextStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodSchedulingContext | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha2PodSchedulingContext** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaim** -> V1alpha2ResourceClaim readNamespacedResourceClaim() - -read the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReadNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReadNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaimParameters** -> V1alpha2ResourceClaimParameters readNamespacedResourceClaimParameters() - -read the specified ResourceClaimParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReadNamespacedResourceClaimParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReadNamespacedResourceClaimParametersRequest = { - // name of the ResourceClaimParameters - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimParameters | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimParameters** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaimStatus** -> V1alpha2ResourceClaim readNamespacedResourceClaimStatus() - -read status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReadNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReadNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaimTemplate** -> V1alpha2ResourceClaimTemplate readNamespacedResourceClaimTemplate() - -read the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReadNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReadNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClassParameters** -> V1alpha2ResourceClassParameters readNamespacedResourceClassParameters() - -read the specified ResourceClassParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReadNamespacedResourceClassParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReadNamespacedResourceClassParametersRequest = { - // name of the ResourceClassParameters - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClassParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClassParameters | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClassParameters** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readResourceClass** -> V1alpha2ResourceClass readResourceClass() - -read the specified ResourceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReadResourceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReadResourceClassRequest = { - // name of the ResourceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readResourceSlice** -> V1alpha2ResourceSlice readResourceSlice() - -read the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReadResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReadResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPodSchedulingContext** -> V1alpha2PodSchedulingContext replaceNamespacedPodSchedulingContext(body) - -replace the specified PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReplaceNamespacedPodSchedulingContextRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReplaceNamespacedPodSchedulingContextRequest = { - // name of the PodSchedulingContext - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - potentialNodes: [ - "potentialNodes_example", - ], - selectedNode: "selectedNode_example", - }, - status: { - resourceClaims: [ - { - name: "name_example", - unsuitableNodes: [ - "unsuitableNodes_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodSchedulingContext(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2PodSchedulingContext**| | - **name** | [**string**] | name of the PodSchedulingContext | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2PodSchedulingContext** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedPodSchedulingContextStatus** -> V1alpha2PodSchedulingContext replaceNamespacedPodSchedulingContextStatus(body) - -replace status of the specified PodSchedulingContext - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReplaceNamespacedPodSchedulingContextStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReplaceNamespacedPodSchedulingContextStatusRequest = { - // name of the PodSchedulingContext - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - potentialNodes: [ - "potentialNodes_example", - ], - selectedNode: "selectedNode_example", - }, - status: { - resourceClaims: [ - { - name: "name_example", - unsuitableNodes: [ - "unsuitableNodes_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodSchedulingContextStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2PodSchedulingContext**| | - **name** | [**string**] | name of the PodSchedulingContext | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2PodSchedulingContext** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaim** -> V1alpha2ResourceClaim replaceNamespacedResourceClaim(body) - -replace the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReplaceNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReplaceNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocationMode: "allocationMode_example", - parametersRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - resourceClassName: "resourceClassName_example", - }, - status: { - allocation: { - availableOnNodes: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - resourceHandles: [ - { - data: "data_example", - driverName: "driverName_example", - structuredData: { - nodeName: "nodeName_example", - results: [ - { - namedResources: { - name: "name_example", - }, - vendorRequestParameters: {}, - }, - ], - vendorClaimParameters: {}, - vendorClassParameters: {}, - }, - }, - ], - shareable: true, - }, - deallocationRequested: true, - driverName: "driverName_example", - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaimParameters** -> V1alpha2ResourceClaimParameters replaceNamespacedResourceClaimParameters(body) - -replace the specified ResourceClaimParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReplaceNamespacedResourceClaimParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReplaceNamespacedResourceClaimParametersRequest = { - // name of the ResourceClaimParameters - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - driverRequests: [ - { - driverName: "driverName_example", - requests: [ - { - namedResources: { - selector: "selector_example", - }, - vendorParameters: {}, - }, - ], - vendorParameters: {}, - }, - ], - generatedFrom: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - shareable: true, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClaimParameters**| | - **name** | [**string**] | name of the ResourceClaimParameters | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimParameters** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaimStatus** -> V1alpha2ResourceClaim replaceNamespacedResourceClaimStatus(body) - -replace status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReplaceNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReplaceNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocationMode: "allocationMode_example", - parametersRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - resourceClassName: "resourceClassName_example", - }, - status: { - allocation: { - availableOnNodes: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - resourceHandles: [ - { - data: "data_example", - driverName: "driverName_example", - structuredData: { - nodeName: "nodeName_example", - results: [ - { - namedResources: { - name: "name_example", - }, - vendorRequestParameters: {}, - }, - ], - vendorClaimParameters: {}, - vendorClassParameters: {}, - }, - }, - ], - shareable: true, - }, - deallocationRequested: true, - driverName: "driverName_example", - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaimTemplate** -> V1alpha2ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) - -replace the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReplaceNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReplaceNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocationMode: "allocationMode_example", - parametersRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - resourceClassName: "resourceClassName_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClaimTemplate**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClassParameters** -> V1alpha2ResourceClassParameters replaceNamespacedResourceClassParameters(body) - -replace the specified ResourceClassParameters - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReplaceNamespacedResourceClassParametersRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReplaceNamespacedResourceClassParametersRequest = { - // name of the ResourceClassParameters - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - filters: [ - { - driverName: "driverName_example", - namedResources: { - selector: "selector_example", - }, - }, - ], - generatedFrom: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - vendorParameters: [ - { - driverName: "driverName_example", - parameters: {}, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClassParameters(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClassParameters**| | - **name** | [**string**] | name of the ResourceClassParameters | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClassParameters** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceResourceClass** -> V1alpha2ResourceClass replaceResourceClass(body) - -replace the specified ResourceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReplaceResourceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReplaceResourceClassRequest = { - // name of the ResourceClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parametersRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - structuredParameters: true, - suitableNodes: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceClass**| | - **name** | [**string**] | name of the ResourceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceResourceSlice** -> V1alpha2ResourceSlice replaceResourceSlice(body) - -replace the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha2Api } from ''; -import type { ResourceV1alpha2ApiReplaceResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha2Api(configuration); - -const request: ResourceV1alpha2ApiReplaceResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - namedResources: { - instances: [ - { - attributes: [ - { - bool: true, - _int: 1, - intSlice: { - ints: [ - 1, - ], - }, - name: "name_example", - quantity: "quantity_example", - string: "string_example", - stringSlice: { - strings: [ - "strings_example", - ], - }, - version: "version_example", - }, - ], - name: "name_example", - }, - ], - }, - nodeName: "nodeName_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2ResourceSlice**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha2ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ResourceV1alpha3Api.md b/src/gen/ResourceV1alpha3Api.md deleted file mode 100644 index c1447e6f05..0000000000 --- a/src/gen/ResourceV1alpha3Api.md +++ /dev/null @@ -1,1029 +0,0 @@ -# .ResourceV1alpha3Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceTaintRule**](ResourceV1alpha3Api.md#createDeviceTaintRule) | **POST** /apis/resource.k8s.io/v1alpha3/devicetaintrules | -[**deleteCollectionDeviceTaintRule**](ResourceV1alpha3Api.md#deleteCollectionDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules | -[**deleteDeviceTaintRule**](ResourceV1alpha3Api.md#deleteDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**getAPIResources**](ResourceV1alpha3Api.md#getAPIResources) | **GET** /apis/resource.k8s.io/v1alpha3/ | -[**listDeviceTaintRule**](ResourceV1alpha3Api.md#listDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules | -[**patchDeviceTaintRule**](ResourceV1alpha3Api.md#patchDeviceTaintRule) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**patchDeviceTaintRuleStatus**](ResourceV1alpha3Api.md#patchDeviceTaintRuleStatus) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | -[**readDeviceTaintRule**](ResourceV1alpha3Api.md#readDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**readDeviceTaintRuleStatus**](ResourceV1alpha3Api.md#readDeviceTaintRuleStatus) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | -[**replaceDeviceTaintRule**](ResourceV1alpha3Api.md#replaceDeviceTaintRule) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**replaceDeviceTaintRuleStatus**](ResourceV1alpha3Api.md#replaceDeviceTaintRuleStatus) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | - - -# **createDeviceTaintRule** -> V1alpha3DeviceTaintRule createDeviceTaintRule(body) - -create a DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; -import type { ResourceV1alpha3ApiCreateDeviceTaintRuleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiCreateDeviceTaintRuleRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - deviceSelector: { - device: "device_example", - driver: "driver_example", - pool: "pool_example", - }, - taint: { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha3DeviceTaintRule**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha3DeviceTaintRule** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionDeviceTaintRule** -> V1Status deleteCollectionDeviceTaintRule() - -delete collection of DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; -import type { ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteDeviceTaintRule** -> V1alpha3DeviceTaintRule deleteDeviceTaintRule() - -delete a DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; -import type { ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1alpha3DeviceTaintRule** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listDeviceTaintRule** -> V1alpha3DeviceTaintRuleList listDeviceTaintRule() - -list or watch objects of kind DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; -import type { ResourceV1alpha3ApiListDeviceTaintRuleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiListDeviceTaintRuleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha3DeviceTaintRuleList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchDeviceTaintRule** -> V1alpha3DeviceTaintRule patchDeviceTaintRule(body) - -partially update the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; -import type { ResourceV1alpha3ApiPatchDeviceTaintRuleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiPatchDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha3DeviceTaintRule** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchDeviceTaintRuleStatus** -> V1alpha3DeviceTaintRule patchDeviceTaintRuleStatus(body) - -partially update status of the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; -import type { ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceTaintRuleStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha3DeviceTaintRule** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readDeviceTaintRule** -> V1alpha3DeviceTaintRule readDeviceTaintRule() - -read the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; -import type { ResourceV1alpha3ApiReadDeviceTaintRuleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReadDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha3DeviceTaintRule** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readDeviceTaintRuleStatus** -> V1alpha3DeviceTaintRule readDeviceTaintRuleStatus() - -read status of the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; -import type { ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest = { - // name of the DeviceTaintRule - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceTaintRuleStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha3DeviceTaintRule** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceDeviceTaintRule** -> V1alpha3DeviceTaintRule replaceDeviceTaintRule(body) - -replace the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; -import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - deviceSelector: { - device: "device_example", - driver: "driver_example", - pool: "pool_example", - }, - taint: { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha3DeviceTaintRule**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha3DeviceTaintRule** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceDeviceTaintRuleStatus** -> V1alpha3DeviceTaintRule replaceDeviceTaintRuleStatus(body) - -replace status of the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from ''; -import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - deviceSelector: { - device: "device_example", - driver: "driver_example", - pool: "pool_example", - }, - taint: { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceTaintRuleStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha3DeviceTaintRule**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha3DeviceTaintRule** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ResourceV1beta1Api.md b/src/gen/ResourceV1beta1Api.md deleted file mode 100644 index 381e04c42c..0000000000 --- a/src/gen/ResourceV1beta1Api.md +++ /dev/null @@ -1,4232 +0,0 @@ -# .ResourceV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceClass**](ResourceV1beta1Api.md#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta1/deviceclasses | -[**createNamespacedResourceClaim**](ResourceV1beta1Api.md#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | -[**createNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | -[**createResourceSlice**](ResourceV1beta1Api.md#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta1/resourceslices | -[**deleteCollectionDeviceClass**](ResourceV1beta1Api.md#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses | -[**deleteCollectionNamespacedResourceClaim**](ResourceV1beta1Api.md#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | -[**deleteCollectionNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | -[**deleteCollectionResourceSlice**](ResourceV1beta1Api.md#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices | -[**deleteDeviceClass**](ResourceV1beta1Api.md#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**deleteNamespacedResourceClaim**](ResourceV1beta1Api.md#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**deleteNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**deleteResourceSlice**](ResourceV1beta1Api.md#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | -[**getAPIResources**](ResourceV1beta1Api.md#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta1/ | -[**listDeviceClass**](ResourceV1beta1Api.md#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses | -[**listNamespacedResourceClaim**](ResourceV1beta1Api.md#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | -[**listNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | -[**listResourceClaimForAllNamespaces**](ResourceV1beta1Api.md#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaims | -[**listResourceClaimTemplateForAllNamespaces**](ResourceV1beta1Api.md#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaimtemplates | -[**listResourceSlice**](ResourceV1beta1Api.md#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices | -[**patchDeviceClass**](ResourceV1beta1Api.md#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**patchNamespacedResourceClaim**](ResourceV1beta1Api.md#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**patchNamespacedResourceClaimStatus**](ResourceV1beta1Api.md#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | -[**patchNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**patchResourceSlice**](ResourceV1beta1Api.md#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | -[**readDeviceClass**](ResourceV1beta1Api.md#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**readNamespacedResourceClaim**](ResourceV1beta1Api.md#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**readNamespacedResourceClaimStatus**](ResourceV1beta1Api.md#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | -[**readNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**readResourceSlice**](ResourceV1beta1Api.md#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | -[**replaceDeviceClass**](ResourceV1beta1Api.md#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**replaceNamespacedResourceClaim**](ResourceV1beta1Api.md#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**replaceNamespacedResourceClaimStatus**](ResourceV1beta1Api.md#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | -[**replaceNamespacedResourceClaimTemplate**](ResourceV1beta1Api.md#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**replaceResourceSlice**](ResourceV1beta1Api.md#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | - - -# **createDeviceClass** -> V1beta1DeviceClass createDeviceClass(body) - -create a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiCreateDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateDeviceClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1DeviceClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceClaim** -> V1beta1ResourceClaim createNamespacedResourceClaim(body) - -create a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiCreateNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceClaimTemplate** -> V1beta1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) - -create a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaimTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createResourceSlice** -> V1beta1ResourceSlice createResourceSlice(body) - -create a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiCreateResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateResourceSliceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - basic: { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - name: "name_example", - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceSlice**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionDeviceClass** -> V1Status deleteCollectionDeviceClass() - -delete collection of DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiDeleteCollectionDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceClaim** -> V1Status deleteCollectionNamespacedResourceClaim() - -delete collection of ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceClaimTemplate** -> V1Status deleteCollectionNamespacedResourceClaimTemplate() - -delete collection of ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionResourceSlice** -> V1Status deleteCollectionResourceSlice() - -delete collection of ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiDeleteCollectionResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteDeviceClass** -> V1beta1DeviceClass deleteDeviceClass() - -delete a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiDeleteDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1beta1DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceClaim** -> V1beta1ResourceClaim deleteNamespacedResourceClaim() - -delete a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceClaimTemplate** -> V1beta1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() - -delete a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteResourceSlice** -> V1beta1ResourceSlice deleteResourceSlice() - -delete a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiDeleteResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listDeviceClass** -> V1beta1DeviceClassList listDeviceClass() - -list or watch objects of kind DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiListDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1DeviceClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceClaim** -> V1beta1ResourceClaimList listNamespacedResourceClaim() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiListNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaimList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceClaimTemplate** -> V1beta1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaimTemplateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClaimForAllNamespaces** -> V1beta1ResourceClaimList listResourceClaimForAllNamespaces() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaimList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClaimTemplateForAllNamespaces** -> V1beta1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaimTemplateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceSlice** -> V1beta1ResourceSliceList listResourceSlice() - -list or watch objects of kind ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiListResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceSliceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchDeviceClass** -> V1beta1DeviceClass patchDeviceClass(body) - -partially update the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiPatchDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaim** -> V1beta1ResourceClaim patchNamespacedResourceClaim(body) - -partially update the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiPatchNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaimStatus** -> V1beta1ResourceClaim patchNamespacedResourceClaimStatus(body) - -partially update status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaimTemplate** -> V1beta1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) - -partially update the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchResourceSlice** -> V1beta1ResourceSlice patchResourceSlice(body) - -partially update the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiPatchResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readDeviceClass** -> V1beta1DeviceClass readDeviceClass() - -read the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiReadDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaim** -> V1beta1ResourceClaim readNamespacedResourceClaim() - -read the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiReadNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaimStatus** -> V1beta1ResourceClaim readNamespacedResourceClaimStatus() - -read status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaimTemplate** -> V1beta1ResourceClaimTemplate readNamespacedResourceClaimTemplate() - -read the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readResourceSlice** -> V1beta1ResourceSlice readResourceSlice() - -read the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiReadResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceDeviceClass** -> V1beta1DeviceClass replaceDeviceClass(body) - -replace the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiReplaceDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1DeviceClass**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaim** -> V1beta1ResourceClaim replaceNamespacedResourceClaim(body) - -replace the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaimStatus** -> V1beta1ResourceClaim replaceNamespacedResourceClaimStatus(body) - -replace status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaimTemplate** -> V1beta1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) - -replace the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaimTemplate**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceResourceSlice** -> V1beta1ResourceSlice replaceResourceSlice(body) - -replace the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from ''; -import type { ResourceV1beta1ApiReplaceResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - basic: { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - name: "name_example", - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceSlice**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/ResourceV1beta2Api.md b/src/gen/ResourceV1beta2Api.md deleted file mode 100644 index c6fec541f3..0000000000 --- a/src/gen/ResourceV1beta2Api.md +++ /dev/null @@ -1,4238 +0,0 @@ -# .ResourceV1beta2Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceClass**](ResourceV1beta2Api.md#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta2/deviceclasses | -[**createNamespacedResourceClaim**](ResourceV1beta2Api.md#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | -[**createNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | -[**createResourceSlice**](ResourceV1beta2Api.md#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta2/resourceslices | -[**deleteCollectionDeviceClass**](ResourceV1beta2Api.md#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses | -[**deleteCollectionNamespacedResourceClaim**](ResourceV1beta2Api.md#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | -[**deleteCollectionNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | -[**deleteCollectionResourceSlice**](ResourceV1beta2Api.md#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices | -[**deleteDeviceClass**](ResourceV1beta2Api.md#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**deleteNamespacedResourceClaim**](ResourceV1beta2Api.md#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**deleteNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**deleteResourceSlice**](ResourceV1beta2Api.md#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | -[**getAPIResources**](ResourceV1beta2Api.md#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta2/ | -[**listDeviceClass**](ResourceV1beta2Api.md#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses | -[**listNamespacedResourceClaim**](ResourceV1beta2Api.md#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | -[**listNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | -[**listResourceClaimForAllNamespaces**](ResourceV1beta2Api.md#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaims | -[**listResourceClaimTemplateForAllNamespaces**](ResourceV1beta2Api.md#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaimtemplates | -[**listResourceSlice**](ResourceV1beta2Api.md#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices | -[**patchDeviceClass**](ResourceV1beta2Api.md#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**patchNamespacedResourceClaim**](ResourceV1beta2Api.md#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**patchNamespacedResourceClaimStatus**](ResourceV1beta2Api.md#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | -[**patchNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**patchResourceSlice**](ResourceV1beta2Api.md#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | -[**readDeviceClass**](ResourceV1beta2Api.md#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**readNamespacedResourceClaim**](ResourceV1beta2Api.md#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**readNamespacedResourceClaimStatus**](ResourceV1beta2Api.md#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | -[**readNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**readResourceSlice**](ResourceV1beta2Api.md#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | -[**replaceDeviceClass**](ResourceV1beta2Api.md#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**replaceNamespacedResourceClaim**](ResourceV1beta2Api.md#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**replaceNamespacedResourceClaimStatus**](ResourceV1beta2Api.md#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | -[**replaceNamespacedResourceClaimTemplate**](ResourceV1beta2Api.md#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**replaceResourceSlice**](ResourceV1beta2Api.md#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | - - -# **createDeviceClass** -> V1beta2DeviceClass createDeviceClass(body) - -create a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiCreateDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateDeviceClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2DeviceClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta2DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceClaim** -> V1beta2ResourceClaim createNamespacedResourceClaim(body) - -create a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiCreateNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedResourceClaimTemplate** -> V1beta2ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) - -create a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaimTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createResourceSlice** -> V1beta2ResourceSlice createResourceSlice(body) - -create a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiCreateResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateResourceSliceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceSlice**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionDeviceClass** -> V1Status deleteCollectionDeviceClass() - -delete collection of DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiDeleteCollectionDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceClaim** -> V1Status deleteCollectionNamespacedResourceClaim() - -delete collection of ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedResourceClaimTemplate** -> V1Status deleteCollectionNamespacedResourceClaimTemplate() - -delete collection of ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionResourceSlice** -> V1Status deleteCollectionResourceSlice() - -delete collection of ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiDeleteCollectionResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteDeviceClass** -> V1beta2DeviceClass deleteDeviceClass() - -delete a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiDeleteDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1beta2DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceClaim** -> V1beta2ResourceClaim deleteNamespacedResourceClaim() - -delete a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedResourceClaimTemplate** -> V1beta2ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() - -delete a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteResourceSlice** -> V1beta2ResourceSlice deleteResourceSlice() - -delete a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiDeleteResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listDeviceClass** -> V1beta2DeviceClassList listDeviceClass() - -list or watch objects of kind DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiListDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta2DeviceClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceClaim** -> V1beta2ResourceClaimList listNamespacedResourceClaim() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiListNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaimList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedResourceClaimTemplate** -> V1beta2ResourceClaimTemplateList listNamespacedResourceClaimTemplate() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaimTemplateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClaimForAllNamespaces** -> V1beta2ResourceClaimList listResourceClaimForAllNamespaces() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaimList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceClaimTemplateForAllNamespaces** -> V1beta2ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaimTemplateList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listResourceSlice** -> V1beta2ResourceSliceList listResourceSlice() - -list or watch objects of kind ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiListResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceSliceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchDeviceClass** -> V1beta2DeviceClass patchDeviceClass(body) - -partially update the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiPatchDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta2DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaim** -> V1beta2ResourceClaim patchNamespacedResourceClaim(body) - -partially update the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiPatchNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaimStatus** -> V1beta2ResourceClaim patchNamespacedResourceClaimStatus(body) - -partially update status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedResourceClaimTemplate** -> V1beta2ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) - -partially update the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchResourceSlice** -> V1beta2ResourceSlice patchResourceSlice(body) - -partially update the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiPatchResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readDeviceClass** -> V1beta2DeviceClass readDeviceClass() - -read the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiReadDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta2DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaim** -> V1beta2ResourceClaim readNamespacedResourceClaim() - -read the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiReadNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaimStatus** -> V1beta2ResourceClaim readNamespacedResourceClaimStatus() - -read status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedResourceClaimTemplate** -> V1beta2ResourceClaimTemplate readNamespacedResourceClaimTemplate() - -read the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readResourceSlice** -> V1beta2ResourceSlice readResourceSlice() - -read the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiReadResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceDeviceClass** -> V1beta2DeviceClass replaceDeviceClass(body) - -replace the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiReplaceDeviceClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2DeviceClass**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta2DeviceClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaim** -> V1beta2ResourceClaim replaceNamespacedResourceClaim(body) - -replace the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaimStatus** -> V1beta2ResourceClaim replaceNamespacedResourceClaimStatus(body) - -replace status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaim** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedResourceClaimTemplate** -> V1beta2ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) - -replace the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaimTemplate**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceClaimTemplate** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceResourceSlice** -> V1beta2ResourceSlice replaceResourceSlice(body) - -replace the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from ''; -import type { ResourceV1beta2ApiReplaceResourceSliceRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceSlice**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta2ResourceSlice** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/SchedulingApi.md b/src/gen/SchedulingApi.md deleted file mode 100644 index 47dbb02fab..0000000000 --- a/src/gen/SchedulingApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .SchedulingApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](SchedulingApi.md#getAPIGroup) | **GET** /apis/scheduling.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, SchedulingApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/SchedulingV1Api.md b/src/gen/SchedulingV1Api.md deleted file mode 100644 index cea65ea8fa..0000000000 --- a/src/gen/SchedulingV1Api.md +++ /dev/null @@ -1,714 +0,0 @@ -# .SchedulingV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createPriorityClass**](SchedulingV1Api.md#createPriorityClass) | **POST** /apis/scheduling.k8s.io/v1/priorityclasses | -[**deleteCollectionPriorityClass**](SchedulingV1Api.md#deleteCollectionPriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses | -[**deletePriorityClass**](SchedulingV1Api.md#deletePriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | -[**getAPIResources**](SchedulingV1Api.md#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1/ | -[**listPriorityClass**](SchedulingV1Api.md#listPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses | -[**patchPriorityClass**](SchedulingV1Api.md#patchPriorityClass) | **PATCH** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | -[**readPriorityClass**](SchedulingV1Api.md#readPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | -[**replacePriorityClass**](SchedulingV1Api.md#replacePriorityClass) | **PUT** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | - - -# **createPriorityClass** -> V1PriorityClass createPriorityClass(body) - -create a PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from ''; -import type { SchedulingV1ApiCreatePriorityClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiCreatePriorityClassRequest = { - - body: { - apiVersion: "apiVersion_example", - description: "description_example", - globalDefault: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - preemptionPolicy: "preemptionPolicy_example", - value: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PriorityClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionPriorityClass** -> V1Status deleteCollectionPriorityClass() - -delete collection of PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from ''; -import type { SchedulingV1ApiDeleteCollectionPriorityClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiDeleteCollectionPriorityClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deletePriorityClass** -> V1Status deletePriorityClass() - -delete a PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from ''; -import type { SchedulingV1ApiDeletePriorityClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiDeletePriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deletePriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listPriorityClass** -> V1PriorityClassList listPriorityClass() - -list or watch objects of kind PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from ''; -import type { SchedulingV1ApiListPriorityClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiListPriorityClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1PriorityClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchPriorityClass** -> V1PriorityClass patchPriorityClass(body) - -partially update the specified PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from ''; -import type { SchedulingV1ApiPatchPriorityClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiPatchPriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1PriorityClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readPriorityClass** -> V1PriorityClass readPriorityClass() - -read the specified PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from ''; -import type { SchedulingV1ApiReadPriorityClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiReadPriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1PriorityClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replacePriorityClass** -> V1PriorityClass replacePriorityClass(body) - -replace the specified PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from ''; -import type { SchedulingV1ApiReplacePriorityClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiReplacePriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - description: "description_example", - globalDefault: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - preemptionPolicy: "preemptionPolicy_example", - value: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityClass**| | - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1PriorityClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/SchedulingV1alpha1Api.md b/src/gen/SchedulingV1alpha1Api.md deleted file mode 100644 index e2734e2b0c..0000000000 --- a/src/gen/SchedulingV1alpha1Api.md +++ /dev/null @@ -1,848 +0,0 @@ -# .SchedulingV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedWorkload**](SchedulingV1alpha1Api.md#createNamespacedWorkload) | **POST** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | -[**deleteCollectionNamespacedWorkload**](SchedulingV1alpha1Api.md#deleteCollectionNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | -[**deleteNamespacedWorkload**](SchedulingV1alpha1Api.md#deleteNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | -[**getAPIResources**](SchedulingV1alpha1Api.md#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1alpha1/ | -[**listNamespacedWorkload**](SchedulingV1alpha1Api.md#listNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | -[**listWorkloadForAllNamespaces**](SchedulingV1alpha1Api.md#listWorkloadForAllNamespaces) | **GET** /apis/scheduling.k8s.io/v1alpha1/workloads | -[**patchNamespacedWorkload**](SchedulingV1alpha1Api.md#patchNamespacedWorkload) | **PATCH** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | -[**readNamespacedWorkload**](SchedulingV1alpha1Api.md#readNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | -[**replaceNamespacedWorkload**](SchedulingV1alpha1Api.md#replaceNamespacedWorkload) | **PUT** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | - - -# **createNamespacedWorkload** -> V1alpha1Workload createNamespacedWorkload(body) - -create a Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from ''; -import type { SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controllerRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - podGroups: [ - { - name: "name_example", - policy: { - basic: {}, - gang: { - minCount: 1, - }, - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1Workload**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1Workload** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedWorkload** -> V1Status deleteCollectionNamespacedWorkload() - -delete collection of Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from ''; -import type { SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedWorkload** -> V1Status deleteNamespacedWorkload() - -delete a Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from ''; -import type { SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedWorkload** -> V1alpha1WorkloadList listNamespacedWorkload() - -list or watch objects of kind Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from ''; -import type { SchedulingV1alpha1ApiListNamespacedWorkloadRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiListNamespacedWorkloadRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha1WorkloadList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listWorkloadForAllNamespaces** -> V1alpha1WorkloadList listWorkloadForAllNamespaces() - -list or watch objects of kind Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from ''; -import type { SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listWorkloadForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha1WorkloadList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedWorkload** -> V1alpha1Workload patchNamespacedWorkload(body) - -partially update the specified Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from ''; -import type { SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1Workload** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedWorkload** -> V1alpha1Workload readNamespacedWorkload() - -read the specified Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from ''; -import type { SchedulingV1alpha1ApiReadNamespacedWorkloadRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiReadNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1Workload** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedWorkload** -> V1alpha1Workload replaceNamespacedWorkload(body) - -replace the specified Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from ''; -import type { SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controllerRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - podGroups: [ - { - name: "name_example", - policy: { - basic: {}, - gang: { - minCount: 1, - }, - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1Workload**| | - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1Workload** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/StorageApi.md b/src/gen/StorageApi.md deleted file mode 100644 index 58bbcaca8f..0000000000 --- a/src/gen/StorageApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .StorageApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](StorageApi.md#getAPIGroup) | **GET** /apis/storage.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, StorageApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/StorageV1Api.md b/src/gen/StorageV1Api.md deleted file mode 100644 index 85f33ae266..0000000000 --- a/src/gen/StorageV1Api.md +++ /dev/null @@ -1,5303 +0,0 @@ -# .StorageV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createCSIDriver**](StorageV1Api.md#createCSIDriver) | **POST** /apis/storage.k8s.io/v1/csidrivers | -[**createCSINode**](StorageV1Api.md#createCSINode) | **POST** /apis/storage.k8s.io/v1/csinodes | -[**createNamespacedCSIStorageCapacity**](StorageV1Api.md#createNamespacedCSIStorageCapacity) | **POST** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | -[**createStorageClass**](StorageV1Api.md#createStorageClass) | **POST** /apis/storage.k8s.io/v1/storageclasses | -[**createVolumeAttachment**](StorageV1Api.md#createVolumeAttachment) | **POST** /apis/storage.k8s.io/v1/volumeattachments | -[**createVolumeAttributesClass**](StorageV1Api.md#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1/volumeattributesclasses | -[**deleteCSIDriver**](StorageV1Api.md#deleteCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**deleteCSINode**](StorageV1Api.md#deleteCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes/{name} | -[**deleteCollectionCSIDriver**](StorageV1Api.md#deleteCollectionCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers | -[**deleteCollectionCSINode**](StorageV1Api.md#deleteCollectionCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes | -[**deleteCollectionNamespacedCSIStorageCapacity**](StorageV1Api.md#deleteCollectionNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | -[**deleteCollectionStorageClass**](StorageV1Api.md#deleteCollectionStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses | -[**deleteCollectionVolumeAttachment**](StorageV1Api.md#deleteCollectionVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments | -[**deleteCollectionVolumeAttributesClass**](StorageV1Api.md#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses | -[**deleteNamespacedCSIStorageCapacity**](StorageV1Api.md#deleteNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**deleteStorageClass**](StorageV1Api.md#deleteStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**deleteVolumeAttachment**](StorageV1Api.md#deleteVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**deleteVolumeAttributesClass**](StorageV1Api.md#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | -[**getAPIResources**](StorageV1Api.md#getAPIResources) | **GET** /apis/storage.k8s.io/v1/ | -[**listCSIDriver**](StorageV1Api.md#listCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers | -[**listCSINode**](StorageV1Api.md#listCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes | -[**listCSIStorageCapacityForAllNamespaces**](StorageV1Api.md#listCSIStorageCapacityForAllNamespaces) | **GET** /apis/storage.k8s.io/v1/csistoragecapacities | -[**listNamespacedCSIStorageCapacity**](StorageV1Api.md#listNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | -[**listStorageClass**](StorageV1Api.md#listStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses | -[**listVolumeAttachment**](StorageV1Api.md#listVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments | -[**listVolumeAttributesClass**](StorageV1Api.md#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses | -[**patchCSIDriver**](StorageV1Api.md#patchCSIDriver) | **PATCH** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**patchCSINode**](StorageV1Api.md#patchCSINode) | **PATCH** /apis/storage.k8s.io/v1/csinodes/{name} | -[**patchNamespacedCSIStorageCapacity**](StorageV1Api.md#patchNamespacedCSIStorageCapacity) | **PATCH** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**patchStorageClass**](StorageV1Api.md#patchStorageClass) | **PATCH** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**patchVolumeAttachment**](StorageV1Api.md#patchVolumeAttachment) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**patchVolumeAttachmentStatus**](StorageV1Api.md#patchVolumeAttachmentStatus) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | -[**patchVolumeAttributesClass**](StorageV1Api.md#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | -[**readCSIDriver**](StorageV1Api.md#readCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**readCSINode**](StorageV1Api.md#readCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes/{name} | -[**readNamespacedCSIStorageCapacity**](StorageV1Api.md#readNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**readStorageClass**](StorageV1Api.md#readStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**readVolumeAttachment**](StorageV1Api.md#readVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**readVolumeAttachmentStatus**](StorageV1Api.md#readVolumeAttachmentStatus) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | -[**readVolumeAttributesClass**](StorageV1Api.md#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | -[**replaceCSIDriver**](StorageV1Api.md#replaceCSIDriver) | **PUT** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**replaceCSINode**](StorageV1Api.md#replaceCSINode) | **PUT** /apis/storage.k8s.io/v1/csinodes/{name} | -[**replaceNamespacedCSIStorageCapacity**](StorageV1Api.md#replaceNamespacedCSIStorageCapacity) | **PUT** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**replaceStorageClass**](StorageV1Api.md#replaceStorageClass) | **PUT** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**replaceVolumeAttachment**](StorageV1Api.md#replaceVolumeAttachment) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**replaceVolumeAttachmentStatus**](StorageV1Api.md#replaceVolumeAttachmentStatus) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | -[**replaceVolumeAttributesClass**](StorageV1Api.md#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | - - -# **createCSIDriver** -> V1CSIDriver createCSIDriver(body) - -create a CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiCreateCSIDriverRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateCSIDriverRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attachRequired: true, - fsGroupPolicy: "fsGroupPolicy_example", - nodeAllocatableUpdatePeriodSeconds: 1, - podInfoOnMount: true, - requiresRepublish: true, - seLinuxMount: true, - serviceAccountTokenInSecrets: true, - storageCapacity: true, - tokenRequests: [ - { - audience: "audience_example", - expirationSeconds: 1, - }, - ], - volumeLifecycleModes: [ - "volumeLifecycleModes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIDriver**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CSIDriver** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createCSINode** -> V1CSINode createCSINode(body) - -create a CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiCreateCSINodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateCSINodeRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - drivers: [ - { - allocatable: { - count: 1, - }, - name: "name_example", - nodeID: "nodeID_example", - topologyKeys: [ - "topologyKeys_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSINode**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CSINode** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createNamespacedCSIStorageCapacity** -> V1CSIStorageCapacity createNamespacedCSIStorageCapacity(body) - -create a CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiCreateNamespacedCSIStorageCapacityRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateNamespacedCSIStorageCapacityRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - capacity: "capacity_example", - kind: "kind_example", - maximumVolumeSize: "maximumVolumeSize_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - nodeTopology: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIStorageCapacity**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CSIStorageCapacity** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createStorageClass** -> V1StorageClass createStorageClass(body) - -create a StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiCreateStorageClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateStorageClassRequest = { - - body: { - allowVolumeExpansion: true, - allowedTopologies: [ - { - matchLabelExpressions: [ - { - key: "key_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - mountOptions: [ - "mountOptions_example", - ], - parameters: { - "key": "key_example", - }, - provisioner: "provisioner_example", - reclaimPolicy: "reclaimPolicy_example", - volumeBindingMode: "volumeBindingMode_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StorageClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1StorageClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createVolumeAttachment** -> V1VolumeAttachment createVolumeAttachment(body) - -create a VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiCreateVolumeAttachmentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateVolumeAttachmentRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attacher: "attacher_example", - nodeName: "nodeName_example", - source: { - inlineVolumeSpec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - persistentVolumeName: "persistentVolumeName_example", - }, - }, - status: { - attachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - attached: true, - attachmentMetadata: { - "key": "key_example", - }, - detachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttachment**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttachment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **createVolumeAttributesClass** -> V1VolumeAttributesClass createVolumeAttributesClass(body) - -create a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiCreateVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateVolumeAttributesClassRequest = { - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttributesClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCSIDriver** -> V1CSIDriver deleteCSIDriver() - -delete a CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteCSIDriverRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1CSIDriver** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCSINode** -> V1CSINode deleteCSINode() - -delete a CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteCSINodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCSINodeRequest = { - // name of the CSINode - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1CSINode** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionCSIDriver** -> V1Status deleteCollectionCSIDriver() - -delete collection of CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteCollectionCSIDriverRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionCSIDriverRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionCSINode** -> V1Status deleteCollectionCSINode() - -delete collection of CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteCollectionCSINodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionCSINodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionNamespacedCSIStorageCapacity** -> V1Status deleteCollectionNamespacedCSIStorageCapacity() - -delete collection of CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionStorageClass** -> V1Status deleteCollectionStorageClass() - -delete collection of StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteCollectionStorageClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionStorageClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionVolumeAttachment** -> V1Status deleteCollectionVolumeAttachment() - -delete collection of VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteCollectionVolumeAttachmentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionVolumeAttachmentRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionVolumeAttributesClass** -> V1Status deleteCollectionVolumeAttributesClass() - -delete collection of VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteCollectionVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteNamespacedCSIStorageCapacity** -> V1Status deleteNamespacedCSIStorageCapacity() - -delete a CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteStorageClass** -> V1StorageClass deleteStorageClass() - -delete a StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteStorageClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteStorageClassRequest = { - // name of the StorageClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1StorageClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteVolumeAttachment** -> V1VolumeAttachment deleteVolumeAttachment() - -delete a VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteVolumeAttachmentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttachment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteVolumeAttributesClass** -> V1VolumeAttributesClass deleteVolumeAttributesClass() - -delete a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiDeleteVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listCSIDriver** -> V1CSIDriverList listCSIDriver() - -list or watch objects of kind CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiListCSIDriverRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListCSIDriverRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1CSIDriverList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listCSINode** -> V1CSINodeList listCSINode() - -list or watch objects of kind CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiListCSINodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListCSINodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1CSINodeList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listCSIStorageCapacityForAllNamespaces** -> V1CSIStorageCapacityList listCSIStorageCapacityForAllNamespaces() - -list or watch objects of kind CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCSIStorageCapacityForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1CSIStorageCapacityList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listNamespacedCSIStorageCapacity** -> V1CSIStorageCapacityList listNamespacedCSIStorageCapacity() - -list or watch objects of kind CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiListNamespacedCSIStorageCapacityRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListNamespacedCSIStorageCapacityRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1CSIStorageCapacityList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listStorageClass** -> V1StorageClassList listStorageClass() - -list or watch objects of kind StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiListStorageClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListStorageClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1StorageClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listVolumeAttachment** -> V1VolumeAttachmentList listVolumeAttachment() - -list or watch objects of kind VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiListVolumeAttachmentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListVolumeAttachmentRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttachmentList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listVolumeAttributesClass** -> V1VolumeAttributesClassList listVolumeAttributesClass() - -list or watch objects of kind VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiListVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttributesClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchCSIDriver** -> V1CSIDriver patchCSIDriver(body) - -partially update the specified CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiPatchCSIDriverRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1CSIDriver** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchCSINode** -> V1CSINode patchCSINode(body) - -partially update the specified CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiPatchCSINodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchCSINodeRequest = { - // name of the CSINode - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1CSINode** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchNamespacedCSIStorageCapacity** -> V1CSIStorageCapacity patchNamespacedCSIStorageCapacity(body) - -partially update the specified CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiPatchNamespacedCSIStorageCapacityRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1CSIStorageCapacity** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchStorageClass** -> V1StorageClass patchStorageClass(body) - -partially update the specified StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiPatchStorageClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchStorageClassRequest = { - // name of the StorageClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1StorageClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchVolumeAttachment** -> V1VolumeAttachment patchVolumeAttachment(body) - -partially update the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiPatchVolumeAttachmentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttachment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchVolumeAttachmentStatus** -> V1VolumeAttachment patchVolumeAttachmentStatus(body) - -partially update status of the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiPatchVolumeAttachmentStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchVolumeAttachmentStatusRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttachmentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttachment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchVolumeAttributesClass** -> V1VolumeAttributesClass patchVolumeAttributesClass(body) - -partially update the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiPatchVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readCSIDriver** -> V1CSIDriver readCSIDriver() - -read the specified CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReadCSIDriverRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1CSIDriver** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readCSINode** -> V1CSINode readCSINode() - -read the specified CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReadCSINodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadCSINodeRequest = { - // name of the CSINode - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1CSINode** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readNamespacedCSIStorageCapacity** -> V1CSIStorageCapacity readNamespacedCSIStorageCapacity() - -read the specified CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReadNamespacedCSIStorageCapacityRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1CSIStorageCapacity** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readStorageClass** -> V1StorageClass readStorageClass() - -read the specified StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReadStorageClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadStorageClassRequest = { - // name of the StorageClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1StorageClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readVolumeAttachment** -> V1VolumeAttachment readVolumeAttachment() - -read the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReadVolumeAttachmentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttachment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readVolumeAttachmentStatus** -> V1VolumeAttachment readVolumeAttachmentStatus() - -read status of the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReadVolumeAttachmentStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadVolumeAttachmentStatusRequest = { - // name of the VolumeAttachment - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttachmentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttachment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readVolumeAttributesClass** -> V1VolumeAttributesClass readVolumeAttributesClass() - -read the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReadVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceCSIDriver** -> V1CSIDriver replaceCSIDriver(body) - -replace the specified CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReplaceCSIDriverRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attachRequired: true, - fsGroupPolicy: "fsGroupPolicy_example", - nodeAllocatableUpdatePeriodSeconds: 1, - podInfoOnMount: true, - requiresRepublish: true, - seLinuxMount: true, - serviceAccountTokenInSecrets: true, - storageCapacity: true, - tokenRequests: [ - { - audience: "audience_example", - expirationSeconds: 1, - }, - ], - volumeLifecycleModes: [ - "volumeLifecycleModes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIDriver**| | - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CSIDriver** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceCSINode** -> V1CSINode replaceCSINode(body) - -replace the specified CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReplaceCSINodeRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceCSINodeRequest = { - // name of the CSINode - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - drivers: [ - { - allocatable: { - count: 1, - }, - name: "name_example", - nodeID: "nodeID_example", - topologyKeys: [ - "topologyKeys_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSINode**| | - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CSINode** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceNamespacedCSIStorageCapacity** -> V1CSIStorageCapacity replaceNamespacedCSIStorageCapacity(body) - -replace the specified CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - capacity: "capacity_example", - kind: "kind_example", - maximumVolumeSize: "maximumVolumeSize_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - nodeTopology: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIStorageCapacity**| | - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1CSIStorageCapacity** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceStorageClass** -> V1StorageClass replaceStorageClass(body) - -replace the specified StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReplaceStorageClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceStorageClassRequest = { - // name of the StorageClass - name: "name_example", - - body: { - allowVolumeExpansion: true, - allowedTopologies: [ - { - matchLabelExpressions: [ - { - key: "key_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - mountOptions: [ - "mountOptions_example", - ], - parameters: { - "key": "key_example", - }, - provisioner: "provisioner_example", - reclaimPolicy: "reclaimPolicy_example", - volumeBindingMode: "volumeBindingMode_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StorageClass**| | - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1StorageClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceVolumeAttachment** -> V1VolumeAttachment replaceVolumeAttachment(body) - -replace the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReplaceVolumeAttachmentRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attacher: "attacher_example", - nodeName: "nodeName_example", - source: { - inlineVolumeSpec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - persistentVolumeName: "persistentVolumeName_example", - }, - }, - status: { - attachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - attached: true, - attachmentMetadata: { - "key": "key_example", - }, - detachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttachment**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttachment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceVolumeAttachmentStatus** -> V1VolumeAttachment replaceVolumeAttachmentStatus(body) - -replace status of the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReplaceVolumeAttachmentStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceVolumeAttachmentStatusRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attacher: "attacher_example", - nodeName: "nodeName_example", - source: { - inlineVolumeSpec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - persistentVolumeName: "persistentVolumeName_example", - }, - }, - status: { - attachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - attached: true, - attachmentMetadata: { - "key": "key_example", - }, - detachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttachmentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttachment**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttachment** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceVolumeAttributesClass** -> V1VolumeAttributesClass replaceVolumeAttributesClass(body) - -replace the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from ''; -import type { StorageV1ApiReplaceVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttributesClass**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/StorageV1alpha1Api.md b/src/gen/StorageV1alpha1Api.md deleted file mode 100644 index 4c5c1ee9f0..0000000000 --- a/src/gen/StorageV1alpha1Api.md +++ /dev/null @@ -1,714 +0,0 @@ -# .StorageV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createVolumeAttributesClass**](StorageV1alpha1Api.md#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses | -[**deleteCollectionVolumeAttributesClass**](StorageV1alpha1Api.md#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses | -[**deleteVolumeAttributesClass**](StorageV1alpha1Api.md#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses/{name} | -[**getAPIResources**](StorageV1alpha1Api.md#getAPIResources) | **GET** /apis/storage.k8s.io/v1alpha1/ | -[**listVolumeAttributesClass**](StorageV1alpha1Api.md#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses | -[**patchVolumeAttributesClass**](StorageV1alpha1Api.md#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses/{name} | -[**readVolumeAttributesClass**](StorageV1alpha1Api.md#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses/{name} | -[**replaceVolumeAttributesClass**](StorageV1alpha1Api.md#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses/{name} | - - -# **createVolumeAttributesClass** -> V1alpha1VolumeAttributesClass createVolumeAttributesClass(body) - -create a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1alpha1Api } from ''; -import type { StorageV1alpha1ApiCreateVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1alpha1Api(configuration); - -const request: StorageV1alpha1ApiCreateVolumeAttributesClassRequest = { - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1VolumeAttributesClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionVolumeAttributesClass** -> V1Status deleteCollectionVolumeAttributesClass() - -delete collection of VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1alpha1Api } from ''; -import type { StorageV1alpha1ApiDeleteCollectionVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1alpha1Api(configuration); - -const request: StorageV1alpha1ApiDeleteCollectionVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteVolumeAttributesClass** -> V1alpha1VolumeAttributesClass deleteVolumeAttributesClass() - -delete a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1alpha1Api } from ''; -import type { StorageV1alpha1ApiDeleteVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1alpha1Api(configuration); - -const request: StorageV1alpha1ApiDeleteVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1alpha1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StorageV1alpha1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listVolumeAttributesClass** -> V1alpha1VolumeAttributesClassList listVolumeAttributesClass() - -list or watch objects of kind VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1alpha1Api } from ''; -import type { StorageV1alpha1ApiListVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1alpha1Api(configuration); - -const request: StorageV1alpha1ApiListVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha1VolumeAttributesClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchVolumeAttributesClass** -> V1alpha1VolumeAttributesClass patchVolumeAttributesClass(body) - -partially update the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1alpha1Api } from ''; -import type { StorageV1alpha1ApiPatchVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1alpha1Api(configuration); - -const request: StorageV1alpha1ApiPatchVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readVolumeAttributesClass** -> V1alpha1VolumeAttributesClass readVolumeAttributesClass() - -read the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1alpha1Api } from ''; -import type { StorageV1alpha1ApiReadVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1alpha1Api(configuration); - -const request: StorageV1alpha1ApiReadVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceVolumeAttributesClass** -> V1alpha1VolumeAttributesClass replaceVolumeAttributesClass(body) - -replace the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1alpha1Api } from ''; -import type { StorageV1alpha1ApiReplaceVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1alpha1Api(configuration); - -const request: StorageV1alpha1ApiReplaceVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1VolumeAttributesClass**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/StorageV1beta1Api.md b/src/gen/StorageV1beta1Api.md deleted file mode 100644 index cd38b76ae0..0000000000 --- a/src/gen/StorageV1beta1Api.md +++ /dev/null @@ -1,714 +0,0 @@ -# .StorageV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createVolumeAttributesClass**](StorageV1beta1Api.md#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | -[**deleteCollectionVolumeAttributesClass**](StorageV1beta1Api.md#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | -[**deleteVolumeAttributesClass**](StorageV1beta1Api.md#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | -[**getAPIResources**](StorageV1beta1Api.md#getAPIResources) | **GET** /apis/storage.k8s.io/v1beta1/ | -[**listVolumeAttributesClass**](StorageV1beta1Api.md#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | -[**patchVolumeAttributesClass**](StorageV1beta1Api.md#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | -[**readVolumeAttributesClass**](StorageV1beta1Api.md#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | -[**replaceVolumeAttributesClass**](StorageV1beta1Api.md#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | - - -# **createVolumeAttributesClass** -> V1beta1VolumeAttributesClass createVolumeAttributesClass(body) - -create a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from ''; -import type { StorageV1beta1ApiCreateVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiCreateVolumeAttributesClassRequest = { - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1VolumeAttributesClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionVolumeAttributesClass** -> V1Status deleteCollectionVolumeAttributesClass() - -delete collection of VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from ''; -import type { StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteVolumeAttributesClass** -> V1beta1VolumeAttributesClass deleteVolumeAttributesClass() - -delete a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from ''; -import type { StorageV1beta1ApiDeleteVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiDeleteVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1beta1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listVolumeAttributesClass** -> V1beta1VolumeAttributesClassList listVolumeAttributesClass() - -list or watch objects of kind VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from ''; -import type { StorageV1beta1ApiListVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiListVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1VolumeAttributesClassList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchVolumeAttributesClass** -> V1beta1VolumeAttributesClass patchVolumeAttributesClass(body) - -partially update the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from ''; -import type { StorageV1beta1ApiPatchVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiPatchVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readVolumeAttributesClass** -> V1beta1VolumeAttributesClass readVolumeAttributesClass() - -read the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from ''; -import type { StorageV1beta1ApiReadVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiReadVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceVolumeAttributesClass** -> V1beta1VolumeAttributesClass replaceVolumeAttributesClass(body) - -replace the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from ''; -import type { StorageV1beta1ApiReplaceVolumeAttributesClassRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiReplaceVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1VolumeAttributesClass**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1VolumeAttributesClass** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/StoragemigrationApi.md b/src/gen/StoragemigrationApi.md deleted file mode 100644 index 3b13b5b46d..0000000000 --- a/src/gen/StoragemigrationApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .StoragemigrationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](StoragemigrationApi.md#getAPIGroup) | **GET** /apis/storagemigration.k8s.io/ | - - -# **getAPIGroup** -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, StoragemigrationApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIGroup** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/StoragemigrationV1alpha1Api.md b/src/gen/StoragemigrationV1alpha1Api.md deleted file mode 100644 index 10d77ca10c..0000000000 --- a/src/gen/StoragemigrationV1alpha1Api.md +++ /dev/null @@ -1,1014 +0,0 @@ -# .StoragemigrationV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createStorageVersionMigration**](StoragemigrationV1alpha1Api.md#createStorageVersionMigration) | **POST** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations | -[**deleteCollectionStorageVersionMigration**](StoragemigrationV1alpha1Api.md#deleteCollectionStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations | -[**deleteStorageVersionMigration**](StoragemigrationV1alpha1Api.md#deleteStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} | -[**getAPIResources**](StoragemigrationV1alpha1Api.md#getAPIResources) | **GET** /apis/storagemigration.k8s.io/v1alpha1/ | -[**listStorageVersionMigration**](StoragemigrationV1alpha1Api.md#listStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations | -[**patchStorageVersionMigration**](StoragemigrationV1alpha1Api.md#patchStorageVersionMigration) | **PATCH** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} | -[**patchStorageVersionMigrationStatus**](StoragemigrationV1alpha1Api.md#patchStorageVersionMigrationStatus) | **PATCH** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status | -[**readStorageVersionMigration**](StoragemigrationV1alpha1Api.md#readStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} | -[**readStorageVersionMigrationStatus**](StoragemigrationV1alpha1Api.md#readStorageVersionMigrationStatus) | **GET** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status | -[**replaceStorageVersionMigration**](StoragemigrationV1alpha1Api.md#replaceStorageVersionMigration) | **PUT** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} | -[**replaceStorageVersionMigrationStatus**](StoragemigrationV1alpha1Api.md#replaceStorageVersionMigrationStatus) | **PUT** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status | - - -# **createStorageVersionMigration** -> V1alpha1StorageVersionMigration createStorageVersionMigration(body) - -create a StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; -import type { StoragemigrationV1alpha1ApiCreateStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request: StoragemigrationV1alpha1ApiCreateStorageVersionMigrationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - continueToken: "continueToken_example", - resource: { - group: "group_example", - resource: "resource_example", - version: "version_example", - }, - }, - status: { - conditions: [ - { - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersionMigration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionStorageVersionMigration** -> V1Status deleteCollectionStorageVersionMigration() - -delete collection of StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; -import type { StoragemigrationV1alpha1ApiDeleteCollectionStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request: StoragemigrationV1alpha1ApiDeleteCollectionStorageVersionMigrationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteStorageVersionMigration** -> V1Status deleteStorageVersionMigration() - -delete a StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; -import type { StoragemigrationV1alpha1ApiDeleteStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request: StoragemigrationV1alpha1ApiDeleteStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listStorageVersionMigration** -> V1alpha1StorageVersionMigrationList listStorageVersionMigration() - -list or watch objects of kind StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; -import type { StoragemigrationV1alpha1ApiListStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request: StoragemigrationV1alpha1ApiListStorageVersionMigrationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersionMigrationList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchStorageVersionMigration** -> V1alpha1StorageVersionMigration patchStorageVersionMigration(body) - -partially update the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; -import type { StoragemigrationV1alpha1ApiPatchStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request: StoragemigrationV1alpha1ApiPatchStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchStorageVersionMigrationStatus** -> V1alpha1StorageVersionMigration patchStorageVersionMigrationStatus(body) - -partially update status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; -import type { StoragemigrationV1alpha1ApiPatchStorageVersionMigrationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request: StoragemigrationV1alpha1ApiPatchStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readStorageVersionMigration** -> V1alpha1StorageVersionMigration readStorageVersionMigration() - -read the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; -import type { StoragemigrationV1alpha1ApiReadStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request: StoragemigrationV1alpha1ApiReadStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readStorageVersionMigrationStatus** -> V1alpha1StorageVersionMigration readStorageVersionMigrationStatus() - -read status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; -import type { StoragemigrationV1alpha1ApiReadStorageVersionMigrationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request: StoragemigrationV1alpha1ApiReadStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceStorageVersionMigration** -> V1alpha1StorageVersionMigration replaceStorageVersionMigration(body) - -replace the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; -import type { StoragemigrationV1alpha1ApiReplaceStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request: StoragemigrationV1alpha1ApiReplaceStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - continueToken: "continueToken_example", - resource: { - group: "group_example", - resource: "resource_example", - version: "version_example", - }, - }, - status: { - conditions: [ - { - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersionMigration**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceStorageVersionMigrationStatus** -> V1alpha1StorageVersionMigration replaceStorageVersionMigrationStatus(body) - -replace status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1alpha1Api } from ''; -import type { StoragemigrationV1alpha1ApiReplaceStorageVersionMigrationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1alpha1Api(configuration); - -const request: StoragemigrationV1alpha1ApiReplaceStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - continueToken: "continueToken_example", - resource: { - group: "group_example", - resource: "resource_example", - version: "version_example", - }, - }, - status: { - conditions: [ - { - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersionMigration**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1alpha1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/StoragemigrationV1beta1Api.md b/src/gen/StoragemigrationV1beta1Api.md deleted file mode 100644 index 566ff5f7f5..0000000000 --- a/src/gen/StoragemigrationV1beta1Api.md +++ /dev/null @@ -1,1011 +0,0 @@ -# .StoragemigrationV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createStorageVersionMigration**](StoragemigrationV1beta1Api.md#createStorageVersionMigration) | **POST** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | -[**deleteCollectionStorageVersionMigration**](StoragemigrationV1beta1Api.md#deleteCollectionStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | -[**deleteStorageVersionMigration**](StoragemigrationV1beta1Api.md#deleteStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**getAPIResources**](StoragemigrationV1beta1Api.md#getAPIResources) | **GET** /apis/storagemigration.k8s.io/v1beta1/ | -[**listStorageVersionMigration**](StoragemigrationV1beta1Api.md#listStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | -[**patchStorageVersionMigration**](StoragemigrationV1beta1Api.md#patchStorageVersionMigration) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**patchStorageVersionMigrationStatus**](StoragemigrationV1beta1Api.md#patchStorageVersionMigrationStatus) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | -[**readStorageVersionMigration**](StoragemigrationV1beta1Api.md#readStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**readStorageVersionMigrationStatus**](StoragemigrationV1beta1Api.md#readStorageVersionMigrationStatus) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | -[**replaceStorageVersionMigration**](StoragemigrationV1beta1Api.md#replaceStorageVersionMigration) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**replaceStorageVersionMigrationStatus**](StoragemigrationV1beta1Api.md#replaceStorageVersionMigrationStatus) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | - - -# **createStorageVersionMigration** -> V1beta1StorageVersionMigration createStorageVersionMigration(body) - -create a StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; -import type { StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - resource: { - group: "group_example", - resource: "resource_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1StorageVersionMigration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteCollectionStorageVersionMigration** -> V1Status deleteCollectionStorageVersionMigration() - -delete collection of StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; -import type { StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **deleteStorageVersionMigration** -> V1Status deleteStorageVersionMigration() - -delete a StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; -import type { StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - - -### Return type - -**V1Status** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **getAPIResources** -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**V1APIResourceList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **listStorageVersionMigration** -> V1beta1StorageVersionMigrationList listStorageVersionMigration() - -list or watch objects of kind StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; -import type { StoragemigrationV1beta1ApiListStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiListStorageVersionMigrationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - - -### Return type - -**V1beta1StorageVersionMigrationList** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchStorageVersionMigration** -> V1beta1StorageVersionMigration patchStorageVersionMigration(body) - -partially update the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; -import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **patchStorageVersionMigrationStatus** -> V1beta1StorageVersionMigration patchStorageVersionMigrationStatus(body) - -partially update status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; -import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - - -### Return type - -**V1beta1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readStorageVersionMigration** -> V1beta1StorageVersionMigration readStorageVersionMigration() - -read the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; -import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **readStorageVersionMigrationStatus** -> V1beta1StorageVersionMigration readStorageVersionMigrationStatus() - -read status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; -import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - - -### Return type - -**V1beta1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceStorageVersionMigration** -> V1beta1StorageVersionMigration replaceStorageVersionMigration(body) - -replace the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; -import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - resource: { - group: "group_example", - resource: "resource_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1StorageVersionMigration**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -# **replaceStorageVersionMigrationStatus** -> V1beta1StorageVersionMigration replaceStorageVersionMigrationStatus(body) - -replace status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from ''; -import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest } from ''; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - resource: { - group: "group_example", - resource: "resource_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1StorageVersionMigration**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - - -### Return type - -**V1beta1StorageVersionMigration** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/VersionApi.md b/src/gen/VersionApi.md deleted file mode 100644 index 4c7dc72758..0000000000 --- a/src/gen/VersionApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .VersionApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getCode**](VersionApi.md#getCode) | **GET** /version/ | - - -# **getCode** -> VersionInfo getCode() - -get the version information for this server - -### Example - - -```typescript -import { createConfiguration, VersionApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new VersionApi(configuration); - -const request = {}; - -const data = await apiInstance.getCode(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**VersionInfo** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - - diff --git a/src/gen/WellKnownApi.md b/src/gen/WellKnownApi.md deleted file mode 100644 index 21eb99e5da..0000000000 --- a/src/gen/WellKnownApi.md +++ /dev/null @@ -1,57 +0,0 @@ -# .WellKnownApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getServiceAccountIssuerOpenIDConfiguration**](WellKnownApi.md#getServiceAccountIssuerOpenIDConfiguration) | **GET** /.well-known/openid-configuration | - - -# **getServiceAccountIssuerOpenIDConfiguration** -> string getServiceAccountIssuerOpenIDConfiguration() - -get service account issuer OpenID configuration, also known as the \'OIDC discovery doc\' - -### Example - - -```typescript -import { createConfiguration, WellKnownApi } from ''; - -const configuration = createConfiguration(); -const apiInstance = new WellKnownApi(configuration); - -const request = {}; - -const data = await apiInstance.getServiceAccountIssuerOpenIDConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - - -### Parameters -This endpoint does not need any parameter. - - -### Return type - -**string** - -### Authorization - -[BearerToken](README.md#BearerToken) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) - -